Skip to content

Commit 10e726c

Browse files
marcin-golebiowskimarcin-golebiowski
committed
Add documentation for SPICE statements and components
- Introduced articles for various SPICE statements including: - .NOISE: Noise analysis syntax and examples - .OP: DC operating point analysis details - .OPTIONS: Simulator options for accuracy and behavior - .PARAM: Definition of named parameters for expressions - .PLOT: Capturing signals for XY plots during simulation - .PRINT: Specifying signals to print as tabular data - .SAVE: Saving signals during simulation - .SPARAM: Defining scalar parameters with immediate evaluation - .ST: Parameter sweep statement for PSpice compatibility - .STEP: Parameter sweep statement with various sweep types - .SUBCKT: Definition of reusable subcircuit blocks - .TEMP: Specifying simulation temperatures - .TRAN: Transient analysis statement - .V: Independent voltage source with various waveform types - .S: Voltage switch with model parameters - .G: Voltage-controlled current source (VCCS) - .E: Voltage-controlled voltage source (VCVS) - .T: Lossless transmission line model - Updated table of contents to include new articles - Enhanced index page with links to articles and categories
1 parent 92082c7 commit 10e726c

59 files changed

Lines changed: 5550 additions & 52 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 50 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -67,61 +67,63 @@ At the moment due to lack of implementation of LAPLACE and FREQ (part of analog
6767
### Dot statements supported:
6868
| Statement | Documentation |
6969
|:------------|-----------------------:|
70-
|.AC |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.AC)|
71-
|.APPENDMODEL |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.APPENDMODEL)|
72-
|.DC |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.DC)|
73-
|.DISTRIBUTION|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.DISTRIBUTION)|
74-
|.ELSE |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.ELSE)|
75-
|.ENDIF |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.ENDIF)|
76-
|.FUNC |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.FUNC)|
77-
|.GLOBAL |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.GLOBAL)|
78-
|.IC |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.IC)|
79-
|.IF |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.IF)|
80-
|.INCLUDE |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.INCLUDE)|
81-
|.LET |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.LET)|
82-
|.LIB |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.LIB)|
83-
|.MC |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.MC)|
84-
|.NODESET |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.NODESET)|
85-
|.NOISE |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.NOISE)|
86-
|.OP |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.OP)|
87-
|.OPTIONS |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.OPTIONS)|
88-
|.PARAM |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.PARAM)|
89-
|.PLOT |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.PLOT)|
90-
|.PRINT |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.PRINT)|
91-
|.TRAN |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.TRAN)|
92-
|.SAVE |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.SAVE)|
93-
|.SPARAM |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.SPARAM)|
94-
|.ST |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.ST)||
95-
|.STEP |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.STEP)|
96-
|.SUBCKT |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.SUBCKT)|
97-
|.TEMP |[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/.TEMP)|
70+
|.AC |[Docs](src/docs/articles/ac.md)|
71+
|.APPENDMODEL |[Docs](src/docs/articles/appendmodel.md)|
72+
|.DC |[Docs](src/docs/articles/dc.md)|
73+
|.DISTRIBUTION|[Docs](src/docs/articles/distribution.md)|
74+
|.ELSE |[Docs](src/docs/articles/if.md)|
75+
|.ENDIF |[Docs](src/docs/articles/if.md)|
76+
|.FUNC |[Docs](src/docs/articles/func.md)|
77+
|.GLOBAL |[Docs](src/docs/articles/global.md)|
78+
|.IC |[Docs](src/docs/articles/ic.md)|
79+
|.IF |[Docs](src/docs/articles/if.md)|
80+
|.INCLUDE |[Docs](src/docs/articles/include.md)|
81+
|.LET |[Docs](src/docs/articles/let.md)|
82+
|.LIB |[Docs](src/docs/articles/lib.md)|
83+
|.MC |[Docs](src/docs/articles/mc.md)|
84+
|.MEAS |[Docs](src/docs/articles/meas.md)|
85+
|.MEASURE |[Docs](src/docs/articles/meas.md)|
86+
|.NODESET |[Docs](src/docs/articles/nodeset.md)|
87+
|.NOISE |[Docs](src/docs/articles/noise.md)|
88+
|.OP |[Docs](src/docs/articles/op.md)|
89+
|.OPTIONS |[Docs](src/docs/articles/options.md)|
90+
|.PARAM |[Docs](src/docs/articles/param.md)|
91+
|.PLOT |[Docs](src/docs/articles/plot.md)|
92+
|.PRINT |[Docs](src/docs/articles/print.md)|
93+
|.TRAN |[Docs](src/docs/articles/tran.md)|
94+
|.SAVE |[Docs](src/docs/articles/save.md)|
95+
|.SPARAM |[Docs](src/docs/articles/sparam.md)|
96+
|.ST |[Docs](src/docs/articles/st.md)|
97+
|.STEP |[Docs](src/docs/articles/step.md)|
98+
|.SUBCKT |[Docs](src/docs/articles/subckt.md)|
99+
|.TEMP |[Docs](src/docs/articles/temp.md)|
98100

99101
### Device statements supported:
100102
| Device Statement | Documentation |
101103
|:------------|-----------------------:|
102-
|B (Arbitrary Behavioral Voltage or Current Source)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/B)|
103-
|C (Capacitor)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/C)|
104-
|D (Diode)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/D)|
105-
|E (Voltage-Controlled Voltage Source)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/E)|
106-
|F (Current-Controlled Current Source)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/F)|
107-
|G (Voltage-Controlled Current Source)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/G)|
108-
|H (Current-Controlled Voltage Source)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/H)|
109-
|I (Independent Current Source)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/I)|
110-
|J (JFET)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/J)|
111-
|K (Mutual Inductance)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/K)|
112-
|L (Inductor)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/L)|
113-
|M (Mosfet)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/M)|
114-
|Q (Bipolar Junction Transistor)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/Q)|
115-
|R (Resistor)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/R)|
116-
|S (Voltage Switch)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/S)|
117-
|T (Lossless Transmission Line)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/T)|
118-
|V (Independent Voltage Source)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/V)|
119-
|W (Current Switch)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/W)|
120-
|X (Subcircuit)|[Wiki](https://github.com/SpiceSharp/SpiceSharpParser/wiki/X)|
104+
|B (Arbitrary Behavioral Voltage or Current Source)|[Docs](src/docs/articles/behavioral-source.md)|
105+
|C (Capacitor)|[Docs](src/docs/articles/capacitor.md)|
106+
|D (Diode)|[Docs](src/docs/articles/diode.md)|
107+
|E (Voltage-Controlled Voltage Source)|[Docs](src/docs/articles/vcvs.md)|
108+
|F (Current-Controlled Current Source)|[Docs](src/docs/articles/cccs.md)|
109+
|G (Voltage-Controlled Current Source)|[Docs](src/docs/articles/vccs.md)|
110+
|H (Current-Controlled Voltage Source)|[Docs](src/docs/articles/ccvs.md)|
111+
|I (Independent Current Source)|[Docs](src/docs/articles/current-source.md)|
112+
|J (JFET)|[Docs](src/docs/articles/jfet.md)|
113+
|K (Mutual Inductance)|[Docs](src/docs/articles/mutual-inductance.md)|
114+
|L (Inductor)|[Docs](src/docs/articles/inductor.md)|
115+
|M (Mosfet)|[Docs](src/docs/articles/mosfet.md)|
116+
|Q (Bipolar Junction Transistor)|[Docs](src/docs/articles/bjt.md)|
117+
|R (Resistor)|[Docs](src/docs/articles/resistor.md)|
118+
|S (Voltage Switch)|[Docs](src/docs/articles/voltage-switch.md)|
119+
|T (Lossless Transmission Line)|[Docs](src/docs/articles/transmission-line.md)|
120+
|V (Independent Voltage Source)|[Docs](src/docs/articles/voltage-source.md)|
121+
|W (Current Switch)|[Docs](src/docs/articles/current-switch.md)|
122+
|X (Subcircuit)|[Docs](src/docs/articles/subcircuit-instance.md)|
121123

122124
## Documentation
125+
* Documentation articles are available in [src/docs/articles](src/docs/articles).
123126
* API documentation is available at <https://spicesharp.github.io/SpiceSharpParser/api/index.html>.
124-
* Wiki is available at <https://github.com/SpiceSharp/SpiceSharpParser/wiki>
125127

126128
## License
127129
SpiceSharpParser is under MIT License

0 commit comments

Comments
 (0)