How iic-jku/analog-circuit-design works
Main Components Identification
• Course Documentation & Content:
• This includes the main Quarto files (analog_circuit_design.qmd, index.qmd), and directories like “content” and “figures”.
• It covers the educational materials (theory, application notes, circuit theorems, design guidelines, and recipes).
• Circuit Simulation & Schematic Management:
• The “cace” directory contains simulation scripts, templates, and documentation related to specific circuits (like OTA designs).
• Sizing & Analysis:
• The “sizing” directory includes Jupyter notebooks (*.ipynb), MATLAB files, and reference PDFs that deal with transistor sizing, technology sweeps, and analysis.
• These materials explore how to train students to extract, plot, and analyze circuit parameters.
• Automation / CI/CD:
• GitHub Actions workflows (in “.github/workflows”) and the Quarto publishing config (“_quarto.yml”) indicate an automated publishing process for updating course material.
• Supporting script files (e.g., clean.sh, convertsch2svg.sh) help automate parts of the design-to-publish flow.
• External Tools Integration:
• The README notes integration with external tools such as Xschem for schematic entry, ngspice for simulation, and the IIC-OSIC-TOOLS Docker image that packages the PDK and toolchain.
Relationships and Interactions
• The Course Documentation serves as the reference and learning hub, linking directly to example circuits, simulation experiments, and design principles documented in “content” and “figures”.
• The “xschem” directory provides the circuit schematics that are referenced in the documentation and are used in conjunction with ngspice simulations.
• Simulation and sizing notebooks (in “sizing”) interact with the circuit designs and model parameters defined within the schematics.
• The “cace” module ties these materials together with standardized templates and automation scripts that prepare simulation reports and simulation files.
• CI/CD workflows ensure that when content is updated (via GitHub), the complete course material is republished automatically to the project site.
Architectural Patterns / Design Principles
• Modular Design: The project is split into self-contained modules – documentation, schematic designs, simulation analysis, and automation pipelines – each with a clear purpose and responsibility.
• Toolchain Integration: The design leverages established open-source tools (Xschem, ngspice, Docker) to maintain a clear separation between educational theory and practical simulation.
• Automated Publishing: The inclusion of GitHub Actions for Quarto publishing shows a pattern of continuous integration for documentation, ensuring the latest materials are always available.
Relevant Technologies and Frameworks
• Quarto: For documentation and publishing (files ending with *.qmd).
• GitHub Actions: For CI/CD (in the workflows directory).
• Xschem and ngspice: For circuit schematic entry and simulation.
• Jupyter Notebooks/ Python Scripts: For data analysis and sizing (files in “sizing” and “cace/scripts”).
• Docker (IIC-OSIC-TOOLS): For standardized toolchain integration.