Repository navigation
Expand file tree
/
Copy pathREADME.html
More file actions
553 lines (470 loc) · 18.5 KB
/
Copy pathREADME.html
File metadata and controls
553 lines (470 loc) · 18.5 KB
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
<?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.12: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z 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 }
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 {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.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;
}
.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 } */
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">
<!-- -*- Mode: rst -*- -->
<!-- -*- Mode: rst -*- -->
<!-- |PySpiceUrl|
|PySpiceHomePage|_
|PySpiceDoc|_
|PySpice@github|_
|PySpice@readthedocs|_
|PySpice@readthedocs-badge|
|PySpice@pypi|_ -->
<!-- .. _PySpice@github: https://github.com/FabriceSalvaire/PySpice -->
<!-- .. _PySpice@readthedocs: http://pyspice.readthedocs.org -->
<!-- .. _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 -*- -->
<!-- End -->
<div class="section" id="pyspice">
<h1>PySpice</h1>
<p>The official PySpice Home Page is located at <a class="reference external" href="http://fabricesalvaire.github.io/PySpice">http://fabricesalvaire.github.io/PySpice</a></p>
<p>The latest documentation build from the git repository is available at readthedocs.org <a class="reference external" href="http://pyspice.readthedocs.org/en/latest"><img alt="PySpice@readthedocs-badge" src="https://readthedocs.org/projects/pyspice/badge/?version=latest" /></a></p>
<p>Written by <a class="reference external" href="http://fabrice-salvaire.pagesperso-orange.fr">Fabrice Salvaire</a>.</p>
<p><a class="reference external" href="https://travis-ci.org/FabriceSalvaire/PySpice"><img alt="PySpice build status @travis-ci.org" src="https://travis-ci.org/FabriceSalvaire/PySpice.svg?branch=master" /></a></p>
<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>
<a class="reference external" href="https://pypi.python.org/pypi/PySpice"><object data="https://img.shields.io/pypi/format/PySpice.svg" type="image/svg+xml">PySpice format</object></a>
<a class="reference external" href="https://pypi.python.org/pypi/PySpice"><object data="https://img.shields.io/pypi/dm/PySpice.svg" type="image/svg+xml">PySpice Download per month</object></a></p>
<hr class="docutils" />
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="news">
<h1>News</h1>
<div class="section" id="v0-3-0">
<h2>V0.3.0</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>
<!-- End -->
<!-- -*- Mode: rst -*- -->
</div>
</div>
<div class="section" id="introduction">
<h1>Introduction</h1>
<p>PySpice is a <a class="reference external" href="http://python.org">Python</a> 3 library which interplay with Berkeley SPICE, the industrial circuit
simulator reference.</p>
<p>SPICE (Simulation Program with Integrated Circuit Emphasis) was developed at the Electronics
Research Laboratory of the University of California, Berkeley in 1973 by Laurence Nagel with
direction from his research advisor, Prof. Donald Pederson. Then Spice emerged as an industrial
standard through its descendants and is still the reference 40 years later.</p>
<p>PySpice is born as a personal project to relearn electronics where circuit simulation is a part of
this goal. Since I use the Python language every day, I quickly feel the need to plug SPICE and Python.</p>
<p>The aim of PySpice is to address several needs:</p>
<blockquote>
<ul class="simple">
<li>SPICE language is fine to describe circuits, but it lacks a real language for circuit
steering. By contrast Python is a powerful high level, oriented object and dynamic language which
is perfectly suited for steering and reusing circuit. But it comes at the price its more general
syntax is less fluent than SPICE for circuit description.</li>
<li>Ngspice provides some extension to Berkeley SPICE for data analysis, but its interactive
environment or TCL module are now outdated. By contrast Python has scientific framework like
<a class="reference external" href="http://www.numpy.org">Numpy</a> and <a class="reference external" href="http://matplotlib.org">Matplotlib</a> that compete with Matlab.</li>
<li>Ngspice source code is derived from Berkeley SPICE and thus has a very old basis. Moreover the
sources are poorly documented. So it is really difficult to understand how it works and modify
it. PySpice could serve to easily experiment extension.</li>
</ul>
</blockquote>
<p>As opposite to other SPICE derivatives, PySpice focus on programming and not on graphical user
interface. Thus it doesn't feature a schematic capture editor and we cannot pickup a node or an
element and plot the associated waveform. Moreover we can notice the <a class="reference external" href="http://www.modelica.org">Modelica</a> language treats
diagrams as annotations. A choice which I consider judicious. Thus we can imagine to follow the
same principle and extend PySpice later.</p>
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="features">
<h1>Features</h1>
<p>The main features of PySpice are:</p>
<blockquote>
<ul class="simple">
<li>actually PySpice only supports <a class="reference external" href="http://ngspice.sourceforge.net">Ngspice</a></li>
<li>an oriented-object API to describe circuit in a way similar to SPICE</li>
<li>a library and model manager that index recursively a directory</li>
<li>an (experimental) SPICE netlist parser. <a class="reference external" href="http://www.kicad-pcb.org">Kicad</a> can be used as schematic editor to simplify the
netlist writing.</li>
<li>a circuit can be simulated using a subprocess (aka server mode) or using the NgSpice shared library,
NgSpice vectors are converted to Numpy array</li>
<li>the NgSpice shared library permits to plug voltage/current sources from Python to NgSpice and vice versa.</li>
<li>some data analysis add-ons</li>
</ul>
</blockquote>
<p>Since PySpice is born with a learning goal, many examples are provided with the sources. These
examples could serve as learning materials. A tool to generate an HTML and PDF documentation is
included in the <em>tools</em> directory. This tool could be extended to generate IPython Notebook as well.</p>
<!-- * an incomplete SPICE parser (mainly used for the library and model indexer)
* a circuit can be simulated using a subprocess (aka server mode) or using the NgSpice shared
library, NgSpice vectors are converted to Numpy array the NgSpice shared library permits to interact
with the simulator and provides Python callback for external voltage and current source
* implement a SPICE to Python converted using the parser. It could be used for the following
workflow: quick circuit sketching using > SPICE netlist > spice2python > PySpice which
could help for complex circuit. -->
<!-- end -->
</div>
<div class="section" id="planned-features">
<h1>Planned Features</h1>
<p>These features are planned in the future:</p>
<blockquote>
<ul class="simple">
<li>implement a basic simulator featuring passive element like resistor, capacitor and inductor.</li>
<li>implement a Modelica backend. <a class="reference external" href="http://www.modelica.org">Modelica</a> is a very interesting solution for transient analysis.</li>
</ul>
</blockquote>
</div>
<div class="section" id="advertisements">
<h1>Advertisements</h1>
<p>Users should be aware of these advertisements.</p>
<div class="warning">
<p class="first admonition-title">Warning</p>
<p class="last">The API is quite unstable until now. Some efforts is made to have a smooth API.</p>
</div>
<div class="warning">
<p class="first admonition-title">Warning</p>
<p class="last">Ngspice and PySpice are provided without any warranty. Thus use it with care for real
design. Best is to cross check the simulation using an industrial grade simulator.</p>
</div>
<div class="warning">
<p class="first admonition-title">Warning</p>
<p class="last">Simulation is a tool and not a perfect representation of the real world.</p>
</div>
<!-- End -->
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="installation">
<span id="installation-page"></span><h1>Installation</h1>
<p>The installation of PySpice by itself is quite simple. However it will be easier to get the
dependencies on a Linux desktop.</p>
<div class="section" id="dependencies">
<h2>Dependencies</h2>
<p>PySpice requires the following dependencies:</p>
<blockquote>
<ul class="simple">
<li><a class="reference external" href="http://python.org">Python</a> 3</li>
<li><a class="reference external" href="http://www.numpy.org">Numpy</a></li>
<li><a class="reference external" href="http://matplotlib.org">Matplotlib</a></li>
<li><a class="reference external" href="http://ngspice.sourceforge.net">Ngspice</a></li>
<li><a class="reference external" href="http://cffi.readthedocs.org/en/latest/">CFFI</a> (only required for Ngspice shared)</li>
</ul>
</blockquote>
<p>Also it is recommanded to have these Python modules:</p>
<blockquote>
<ul class="simple">
<li><a class="reference external" href="http://ipython.org">IPython</a></li>
<li>pip</li>
<li>virtualenv</li>
</ul>
</blockquote>
<p>For development, you will need in addition:</p>
<blockquote>
<ul class="simple">
<li><a class="reference external" href="http://sphinx-doc.org">Sphinx</a></li>
<li>circuit_macros and a LaTeX environment</li>
</ul>
</blockquote>
</div>
<div class="section" id="ngspice-compilation">
<h2>Ngspice Compilation</h2>
<p>Usually Ngspice is available as a package in the major Linux distributions. But I recommend to check
the compilation options before to use it extensively. For example the Fedora package enables too
many experimental codes that have side effects. The recommended way to compile Ngspice is given in
the manual and the <tt class="docutils literal">INSTALLATION</tt> file. Ngspice is an example of complex software where we should
not enable everything without care.</p>
<!-- :file:`INSTALLATION` -->
<div class="warning">
<p class="first admonition-title">Warning</p>
<p class="last">For the following, the compilation option <strong>--enable-ndev</strong> is known to broke the server mode.</p>
</div>
</div>
<div class="section" id="installation-from-pypi-repository">
<h2>Installation from PyPi Repository</h2>
<p>PySpice is made available on the <a class="reference external" href="https://pypi.python.org/pypi">PyPI</a> repository at <a class="reference external" href="https://pypi.python.org/pypi/PySpice">https://pypi.python.org/pypi/PySpice</a></p>
<p>Run this command to install the last release:</p>
<pre class="code sh literal-block">
pip install PySpice
</pre>
</div>
<div class="section" id="installation-from-source">
<h2>Installation from Source</h2>
<p>The PySpice source code is hosted at <a class="reference external" href="https://github.com/FabriceSalvaire/PySpice">https://github.com/FabriceSalvaire/PySpice</a></p>
<p>To clone the Git repository, run this command in a terminal:</p>
<pre class="code sh literal-block">
git clone git@github.com:FabriceSalvaire/PySpice.git
</pre>
<p>Then to build and install PySpice run these commands:</p>
<pre class="code sh literal-block">
python setup.py build
python setup.py install
</pre>
<!-- End -->
<!-- End -->
</div>
</div>
</div>
</body>
</html>