forked from PySpice-org/PySpice
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
559 lines (473 loc) · 16.3 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<title>PySpice : Simulate Electronic Circuit using Python and the Ngspice / Xyce Simulators</title>
<style type="text/css">
/*
:Author: David Goodger ([email protected])
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="pyspice-simulate-electronic-circuit-using-python-and-the-ngspice-xyce-simulators">
<h1 class="title">PySpice : Simulate Electronic Circuit using Python and the Ngspice / Xyce Simulators</h1>
<!-- -*- Mode: rst -*- -->
<!-- -*- Mode: rst -*- -->
<!-- |PySpiceUrl|
|PySpiceHomePage|_
|PySpiceDoc|_
|PySpice@github|_
|PySpice@readthedocs|_
|PySpice@readthedocs-badge|
|PySpice@pypi|_ -->
<!-- .. |PySpice@readthedocs-badge| image:: https://readthedocs.org/projects/pyspice/badge/?version=latest -->
<!-- :target: http://pyspice.readthedocs.org/en/latest -->
<!-- .. _PySpice@github: https://github.com/FabriceSalvaire/PySpice -->
<!-- .. _PySpice@pypi: https://pypi.python.org/pypi/PySpice -->
<!-- coverage test -->
<!-- https://img.shields.io/pypi/status/Django.svg -->
<!-- https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star -->
<!-- End -->
<!-- -*- Mode: rst -*- -->
<p><a class="reference external" href="https://pypi.python.org/pypi/PySpice"><object data="https://img.shields.io/pypi/l/PySpice.svg" type="image/svg+xml">PySpice license</object></a>
<a class="reference external" href="https://pypi.python.org/pypi/PySpice"><object data="https://img.shields.io/pypi/pyversions/PySpice.svg" type="image/svg+xml">PySpice python version</object></a></p>
<p><a class="reference external" href="https://pypi.python.org/pypi/PySpice"><object data="https://img.shields.io/pypi/v/PySpice.svg" type="image/svg+xml">PySpice last version</object></a></p>
<ul class="simple">
<li>Quick Link to <a class="reference external" href="https://github.com/FabriceSalvaire/PySpice/tree/master">Production Branch</a></li>
<li>Quick Link to <a class="reference external" href="https://github.com/FabriceSalvaire/PySpice/tree/devel">Devel Branch</a></li>
</ul>
<div class="section" id="overview">
<h1>Overview</h1>
<div class="section" id="what-is-pyspice">
<h2>What is PySpice ?</h2>
<p>PySpice is a Python module which interface <a class="reference external" href="http://python.org">Python</a> to the <a class="reference external" href="http://ngspice.sourceforge.net">Ngspice</a> and <a class="reference external" href="https://xyce.sandia.gov">Xyce</a> circuit
simulators.</p>
</div>
<div class="section" id="where-is-the-documentation">
<h2>Where is the Documentation ?</h2>
<p>The documentation is available on the <a class="reference external" href="https://pyspice.fabrice-salvaire.fr">PySpice Home Page</a>.</p>
</div>
<div class="section" id="what-are-the-main-features">
<h2>What are the main features ?</h2>
<ul class="simple">
<li>support Ngspice and Xyce circuit simulators</li>
<li>support <strong>Linux</strong>, <strong>Windows</strong> and Mac <strong>OS X</strong> platforms</li>
<li>licensed under <strong>GPLv3</strong> therms</li>
<li>implement an <strong>Ngspice shared library binding</strong> using CFFI which support external sources</li>
<li>implement (partial) <strong>SPICE netlist parser</strong></li>
<li>implement an <strong>Oriented Object API</strong> to define circuit</li>
<li>export simulation output to <a class="reference external" href="http://www.numpy.org">Numpy</a> arrays</li>
<li>plot using <a class="reference external" href="http://matplotlib.org">Matplotlib</a></li>
<li>handle <strong>units</strong></li>
<li>work with <strong>Kicad schematic editor</strong></li>
<li>implement a <strong>documentation generator</strong></li>
<li>provides many <strong>examples</strong></li>
</ul>
</div>
<div class="section" id="how-to-install-it">
<h2>How to install it ?</h2>
<p>Look at the <a class="reference external" href="https://pyspice.fabrice-salvaire.fr/installation.html">installation</a> section in the documentation.</p>
</div>
</div>
<div class="section" id="credits">
<h1>Credits</h1>
<p>Authors: <a class="reference external" href="http://fabrice-salvaire.fr">Fabrice Salvaire</a></p>
</div>
<div class="section" id="news">
<h1>News</h1>
<!-- -*- Mode: rst -*- -->
<!-- no title here -->
<div class="section" id="v1-4-0-development-release">
<h2>V1.4.0 (development release)</h2>
</div>
<div class="section" id="v1-3-2-production-release-2019-03-11">
<h2>V1.3.2 (production release) 2019-03-11</h2>
<blockquote>
<ul class="simple">
<li>support Ngspice 30 and Xyce 6.10</li>
<li>fixed NgSpice and Xyce support on Windows 10</li>
<li>bug fixes</li>
</ul>
</blockquote>
</div>
<div class="section" id="v1-2-0-2018-06-07">
<h2>V1.2.0 2018-06-07</h2>
<blockquote>
<ul class="simple">
<li>Initial support of the <a class="reference external" href="https://xyce.sandia.gov">Xyce</a> simulator. Xyce is an open source, SPICE-compatible,
high-performance analog circuit simulator, capable of solving extremely large circuit problems
developed at Sandia National Laboratories. Xyce will make PySpice suitable for industry and
research use.</li>
<li>Fixed OSX support</li>
<li>Splitted G device</li>
<li>Implemented partially <cite>A</cite> XSPICE device</li>
<li>Implemented missing transmission line devices</li>
<li>Implemented high level current sources
<strong>Notice: Some classes were renamed !</strong></li>
<li>Implemented node kwarg e.g. <code>circuit.Q(1, base=1, collector=2, emitter=3, model='npn')</code></li>
<li>Implemented raw spice pass through (see <a class="reference external" href="/faq.html">User FAQ</a>)</li>
<li>Implemented access to internal parameters (cf. <code>save @device[parameter]</code>)</li>
<li>Implemented check for missing ground node</li>
<li>Implemented a way to disable an element and clone netlist</li>
<li>Improved SPICE parser</li>
<li>Improved unit support:<ul>
<li>Implemented unit prefix cast <cite>U_μV(U_mV(1))</cite> to easily convert values</li>
<li>Added <cite>U_mV</cite>, ... shortcuts</li>
<li>Added Numpy array support to unit, see <cite>UnitValues</cite> <strong>Notice: this new feature could be buggy !!!</strong></li>
<li>Rebased <cite>WaveForm</cite> to <cite>UnitValues</cite></li>
</ul>
</li>
<li>Fixed node order so as to not confuse users <strong>Now PySpice matches SPICE order for two ports elements !</strong></li>
<li>Fixed device shortcuts in <cite>Netlist</cite> class</li>
<li>Fixed model kwarg for BJT <strong>Notice: it must be passed exclusively as kwarg !</strong></li>
<li>Fixed subcircuit nesting</li>
<li>Outsourced documentation generator to <a class="reference external" href="https://github.com/FabriceSalvaire/Pyterate">Pyterate</a></li>
<li>Updated <cite>setup.py</cite> for wheel</li>
</ul>
</blockquote>
<!-- :ref:`user-faq-page` -->
</div>
<div class="section" id="v1-1-0-2017-09-06">
<h2>V1.1.0 2017-09-06</h2>
<blockquote>
<ul class="simple">
<li>Enhanced shared mode</li>
<li>Shared mode is now set as default on Linux</li>
</ul>
</blockquote>
</div>
<div class="section" id="v1-0-0-2017-09-06">
<h2>V1.0.0 2017-09-06</h2>
<blockquote>
<ul class="simple">
<li>Bump version to v1.0.0 since it just works!</li>
<li>Support Windows platform using Ngspice shared mode</li>
<li>Fixed shared mode</li>
<li>Fixed and completed Spice parser : tested on example's libraries</li>
</ul>
</blockquote>
</div>
<div class="section" id="v0-4-2">
<h2>V0.4.2</h2>
<blockquote>
<ul class="simple">
<li>Fixed Spice parser for lower case device prefix.</li>
</ul>
</blockquote>
</div>
<div class="section" id="v0-4-0-2017-07-31">
<h2>V0.4.0 2017-07-31</h2>
<blockquote>
<ul class="simple">
<li>Git repository cleanup: filtered generated doc and useless files so as to shrink the repository size.</li>
<li>Improved documentation generator: Implemented <code>format</code> for RST content and Tikz figure.</li>
<li>Improved unit support: It implements now the International System of Units.
And we can now use unit helper like <code>u_mV</code> or compute the value of <code>1.2@u_kΩ / 2@u_mA</code>.
The relevant documentation is on this <a class="reference external" href="api/PySpice/Unit.html">page</a>.</li>
<li>Added the Simulation instance to the Analysis class.</li>
<li>Refactored simulation parameters as classes.</li>
</ul>
</blockquote>
</div>
<div class="section" id="v0-3-2-2017-02-22">
<h2>V0.3.2 2017-02-22</h2>
<blockquote>
<ul class="simple">
<li>fixed CCCS and CCVS</li>
</ul>
</blockquote>
</div>
<div class="section" id="v0-3-1-2017-02-22">
<h2>V0.3.1 2017-02-22</h2>
<blockquote>
<ul class="simple">
<li>fixed ngspice shared</li>
</ul>
</blockquote>
</div>
<div class="section" id="v0-3-0-2015-12-08">
<h2>V0.3.0 2015-12-08</h2>
<blockquote>
<ul class="simple">
<li>Added an example to show how to use the NgSpice Shared Simulation Mode.</li>
<li>Completed the Spice netlist parser and added examples, we could now use a schematic editor
to define the circuit. The program <em>cir2py</em> translates a circuit file to Python.</li>
</ul>
</blockquote>
</div>
<div class="section" id="v0-2014-03-21">
<h2>V0 2014-03-21</h2>
<p>Started project</p>
<!-- End -->
<!-- End -->
</div>
</div>
</div>
</body>
</html>