API Reference¶
Complete API documentation for gds-software, auto-generated from source docstrings.
Common¶
| Module | Description |
|---|---|
| gds_software | Package root -- version, top-level imports |
| gds_software.common | Shared types, errors, compilation utilities |
Data Flow Diagrams¶
| Module | Description |
|---|---|
| gds_software.dfd.elements | ExternalEntity, Process, DataStore, DataFlow declarations |
| gds_software.dfd.model | DFDModel container |
| gds_software.dfd.compile | DFD -> GDSSpec / SystemIR compiler |
| gds_software.dfd.checks | DFD-001..DFD-005 verification checks |
State Machines¶
| Module | Description |
|---|---|
| gds_software.statemachine.elements | State, Event, Transition, Guard, Region |
| gds_software.statemachine.model | StateMachineModel container |
| gds_software.statemachine.compile | SM -> GDSSpec / SystemIR compiler |
| gds_software.statemachine.checks | SM-001..SM-006 verification checks |
Component Diagrams¶
| Module | Description |
|---|---|
| gds_software.component.elements | Component, InterfaceDef, Connector |
| gds_software.component.model | ComponentModel container |
| gds_software.component.compile | Component -> GDSSpec / SystemIR compiler |
| gds_software.component.checks | CP-001..CP-004 verification checks |
C4 Models¶
| Module | Description |
|---|---|
| gds_software.c4.elements | Person, ExternalSystem, Container, C4Component, C4Relationship |
| gds_software.c4.model | C4Model container |
| gds_software.c4.compile | C4 -> GDSSpec / SystemIR compiler |
| gds_software.c4.checks | C4-001..C4-004 verification checks |
Entity-Relationship Diagrams¶
| Module | Description |
|---|---|
| gds_software.erd.elements | ERDEntity, Attribute, ERDRelationship, Cardinality |
| gds_software.erd.model | ERDModel container |
| gds_software.erd.compile | ERD -> GDSSpec / SystemIR compiler |
| gds_software.erd.checks | ER-001..ER-004 verification checks |
Dependency Graphs¶
| Module | Description |
|---|---|
| gds_software.dependency.elements | Module, Dep, Layer |
| gds_software.dependency.model | DependencyModel container |
| gds_software.dependency.compile | Dependency -> GDSSpec / SystemIR compiler |
| gds_software.dependency.checks | DG-001..DG-004 verification checks |
Verification¶
| Module | Description |
|---|---|
| gds_software.verification | Union dispatch verify() engine |