# p-rer/invertersimulation architecture

> Architecture diagram of the GitHub repository p-rer/invertersimulation, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/p-rer/invertersimulation
- Repository: https://github.com/p-rer/invertersimulation

## Overview

##### Project type and purpose
- This is a domain-specific simulation tool (a SPICE-like inverter circuit simulator).
- Purpose: parse a netlist, build an in-memory circuit model of components (resistors, capacitors, inductors, transistors, sources, etc.), run nodal analysis or transient analysis, and report results.

##### File structure
- Top-level:
- main.py – entry point (CLI or script)
- README.md – high-level description
- Circuit/ – holds the Circuit class (graph, node management, etc.)
- CircuitElement/ – one file per element type: BJT, R, C, L, diode, voltage/current sources
- Simulator/ – core engine: NetlistParser.py and Simulator.py

##### Key insights from README
- “インバータ回路シミュレーション” (= inverter circuit simulation)
- “Spiceと同様の解析を行う” implies support for netlist parsing, component stamping, solver routines

##### Main components
a. CLI / User Interface
- main.py
b. Netlist Parser
- Simulator/NetlistParser.py
- Responsibility: read text netlist, produce component definitions and connectivity
c. Circuit Model
- Circuit/Circuit.py
- Holds nodes, element registry, adjacency, trimming, stamping hooks
d. Component Library
- CircuitElement/*.py
- Each subclass implements stamping into system matrices
e. Simulation Engine
- Simulator/Simulator.py
- Implements analysis (e.g., DC operating point, transient), matrix assembly, solver calls
f. (Optional) Output / Reporter
- Could be part of main.py or Simulator output routines

##### Architectural patterns and design principles
- Modular separation: parser, model, solver, and elements decoupled
- Strategy / polymorphism: each CircuitElement stamps its own contribution
- Single Responsibility: NetlistParser only parses; Circuit only manages structure; Simulator only runs analysis.

##### Technologies and libraries

- Another for “domain classes” (green)
- A third for “external libraries” or “utilities” (gray)

a. Sketch a central “Simulator App” boundary.
g. “External Solver Library” connected to “Simulation Engine”.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Simulator App"
        direction TB
        main["main.py (CLI / Orchestrator)"]:::package
        subgraph "Parser Module"
            NP["NetlistParser"]:::package
        end
        subgraph "Model Module"
            CM["Circuit"]:::domain
        end
        subgraph "Component Library"
            CEL["CircuitElement (base)"]:::domain
            R["Resistor"]:::domain
            C["Capacitor"]:::domain
            L["Inductor"]:::domain
            BJT["BJT"]:::domain
            D["Diode"]:::domain
            VS["VoltageSource"]:::domain
            CS["CurrentSource"]:::domain
        end
        subgraph "Engine Module"
            SIM["Simulator"]:::package
            EXTSOL["External Solver Library"]:::external
        end
        Results["Results / Output"]:::package
    end

    main --> NP
    main --> SIM
    NP --> CM
    CEL --> CM
    R --> CM
    C --> CM
    L --> CM
    BJT --> CM
    D --> CM
    VS --> CM
    CS --> CM
    CM --> SIM
    SIM --> EXTSOL
    SIM --> Results
    Results --> main

    DOC["README.md"]:::external

    click main "https://github.com/p-rer/invertersimulation/blob/main/main.py"
    click NP "https://github.com/p-rer/invertersimulation/blob/main/Simulator/NetlistParser.py"
    click CM "https://github.com/p-rer/invertersimulation/blob/main/Circuit/Circuit.py"
    click CEL "https://github.com/p-rer/invertersimulation/blob/main/CircuitElement/CircuitElement.py"
    click R "https://github.com/p-rer/invertersimulation/blob/main/CircuitElement/Resistor.py"
    click C "https://github.com/p-rer/invertersimulation/blob/main/CircuitElement/Capacitor.py"
    click L "https://github.com/p-rer/invertersimulation/blob/main/CircuitElement/Inductor.py"
    click BJT "https://github.com/p-rer/invertersimulation/blob/main/CircuitElement/BJT.py"
    click D "https://github.com/p-rer/invertersimulation/blob/main/CircuitElement/Diode.py"
    click VS "https://github.com/p-rer/invertersimulation/blob/main/CircuitElement/VoltageSource.py"
    click CS "https://github.com/p-rer/invertersimulation/blob/main/CircuitElement/CurrentSource.py"
    click SIM "https://github.com/p-rer/invertersimulation/blob/main/Simulator/Simulator.py"
    click DOC "https://github.com/p-rer/invertersimulation/blob/main/README.md"

    classDef package fill:#D0E6FF,stroke:#036,stroke-width:1px
    classDef domain fill:#DFFFD6,stroke:#080,stroke-width:1px
    classDef external fill:#E0E0E0,stroke:#666,stroke-width:1px
```
