forked from PySpice-org/PySpice
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
876 lines (798 loc) · 31.4 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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="utf-8"/>
<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" />
<title>PySpice : Simulate Electronic Circuit using Python and the Ngspice / Xyce Simulators</title>
<style type="text/css">
/* Minimal style sheet for the HTML output of Docutils. */
/* */
/* :Author: Günter Milde, based on html4css1.css by David Goodger */
/* :Id: $Id: minimal.css 8397 2019-09-20 11:09:34Z milde $ */
/* :Copyright: © 2015 Günter Milde. */
/* :License: Released under the terms of the `2-Clause BSD license`_, */
/* in short: */
/* */
/* Copying and distribution of this file, with or without modification, */
/* are permitted in any medium without royalty provided the copyright */
/* notice and this notice are preserved. */
/* */
/* This file is offered as-is, without any warranty. */
/* */
/* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause */
/* This CSS2.1_ stylesheet defines rules for Docutils elements without */
/* HTML equivalent. It is required to make the document semantic visible. */
/* */
/* .. _CSS2.1: http://www.w3.org/TR/CSS2 */
/* .. _validates: http://jigsaw.w3.org/css-validator/validator$link */
/* alignment of text and inline objects inside block objects*/
.align-left { text-align: left; }
.align-right { text-align: right; }
.align-center { clear: both; text-align: center; }
.align-top { vertical-align: top; }
.align-middle { vertical-align: middle; }
.align-bottom { vertical-align: bottom; }
/* titles */
h1.title, p.subtitle {
text-align: center;
}
p.topic-title,
p.sidebar-title,
p.rubric,
p.admonition-title,
p.system-message-title {
font-weight: bold;
}
h1 + p.subtitle,
h1 + p.section-subtitle {
font-size: 1.6em;
}
h2 + p.section-subtitle { font-size: 1.28em; }
p.subtitle,
p.section-subtitle,
p.sidebar-subtitle {
font-weight: bold;
margin-top: -0.5em;
}
p.sidebar-title,
p.rubric {
font-size: larger;
}
p.rubric { color: maroon; }
a.toc-backref {
color: black;
text-decoration: none; }
/* Warnings, Errors */
div.caution p.admonition-title,
div.attention p.admonition-title,
div.danger p.admonition-title,
div.error p.admonition-title,
div.warning p.admonition-title,
div.system-messages h1,
div.error,
span.problematic,
p.system-message-title {
color: red;
}
/* inline literals */
span.docutils.literal {
font-family: monospace;
white-space: pre-wrap;
}
/* do not wraph at hyphens and similar: */
.literal > span.pre { white-space: nowrap; }
/* Lists */
/* compact and simple lists: no margin between items */
.simple li, .compact li,
.simple ul, .compact ul,
.simple ol, .compact ol,
.simple > li p, .compact > li p,
dl.simple > dd, dl.compact > dd {
margin-top: 0;
margin-bottom: 0;
}
/* Table of Contents */
div.topic.contents { margin: 0.5em 0; }
div.topic.contents ul {
list-style-type: none;
padding-left: 1.5em;
}
/* Enumerated Lists */
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 }
dt span.classifier { font-style: italic }
dt span.classifier:before {
font-style: normal;
margin: 0.5em;
content: ":";
}
/* Field Lists and drivatives */
/* bold field name, content starts on the same line */
dl.field-list > dt,
dl.option-list > dt,
dl.docinfo > dt,
dl.footnote > dt,
dl.citation > dt {
font-weight: bold;
clear: left;
float: left;
margin: 0;
padding: 0;
padding-right: 0.5em;
}
/* Offset for field content (corresponds to the --field-name-limit option) */
dl.field-list > dd,
dl.option-list > dd,
dl.docinfo > dd {
margin-left: 9em; /* ca. 14 chars in the test examples */
}
/* start field-body on a new line after long field names */
dl.field-list > dd > *:first-child,
dl.option-list > dd > *:first-child
{
display: inline-block;
width: 100%;
margin: 0;
}
/* field names followed by a colon */
dl.field-list > dt:after,
dl.docinfo > dt:after {
content: ":";
}
/* Bibliographic Fields (docinfo) */
pre.address { font: inherit; }
dd.authors > p { margin: 0; }
/* Option Lists */
dl.option-list { margin-left: 1.5em; }
dl.option-list > dt { font-weight: normal; }
span.option { white-space: nowrap; }
/* Footnotes and Citations */
dl.footnote.superscript > dd {margin-left: 1em; }
dl.footnote.brackets > dd {margin-left: 2em; }
dl > dt.label { font-weight: normal; }
a.footnote-reference.brackets:before,
dt.label > span.brackets:before { content: "["; }
a.footnote-reference.brackets:after,
dt.label > span.brackets:after { content: "]"; }
a.footnote-reference.superscript,
dl.footnote.superscript > dt.label {
vertical-align: super;
font-size: smaller;
}
dt.label > span.fn-backref { margin-left: 0.2em; }
dt.label > span.fn-backref > a { font-style: italic; }
/* Line Blocks */
div.line-block { display: block; }
div.line-block div.line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 40px;
}
/* Figures, Images, and Tables */
.figure.align-left,
figure.align-left,
img.align-left,
object.align-left,
table.align-left {
margin-right: auto;
}
.figure.align-center,
figure.align-center,
img.align-center,
object.align-center,
table.align-center {
margin-left: auto;
margin-right: auto;
}
.figure.align-right,
figure.align-right,
img.align-right,
object.align-right,
table.align-right {
margin-left: auto;
}
.figure.align-center, .figure.align-right,
figure.align-center, figure.align-right,
img.align-center, img.align-right,
object.align-center, object.align-right {
display: block;
}
/* reset inner alignment in figures and tables */
.figure.align-left, .figure.align-right,
figure.align-left, figure.align-right,
table.align-left, table.align-center, table.align-right {
text-align: inherit;
}
/* Admonitions and System Messages */
div.admonition,
div.system-message,
div.sidebar,
aside.sidebar {
margin: 1em 1.5em;
border: medium outset;
padding-top: 0.5em;
padding-bottom: 0.5em;
padding-right: 1em;
padding-left: 1em;
}
/* Sidebar */
div.sidebar,
aside.sidebar {
width: 30%;
max-width: 26em;
float: right;
clear: right;
}
/* Text Blocks */
blockquote,
div.topic,
pre.literal-block,
pre.doctest-block,
pre.math,
pre.code {
margin-left: 1.5em;
margin-right: 1.5em;
}
pre.code .ln { color: gray; } /* line numbers */
/* Tables */
table { border-collapse: collapse; }
td, th {
border-style: solid;
border-color: silver;
padding: 0 1ex;
border-width: thin;
}
td > p:first-child, th > p:first-child { margin-top: 0; }
td > p, th > p { margin-bottom: 0; }
table > caption {
text-align: left;
margin-bottom: 0.25em
}
table.borderless td, table.borderless th {
border: 0;
padding: 0;
padding-right: 0.5em /* separate table cells */
}
/* Document Header and Footer */
/* div.header, */
/* header { border-bottom: 1px solid black; } */
/* div.footer, */
/* footer { border-top: 1px solid black; } */
/* new HTML5 block elements: set display for older browsers */
header, section, footer, aside, nav, main, article, figure {
display: block;
}
</style>
<style type="text/css">
/* CSS31_ style sheet for the output of Docutils HTML writers. */
/* Rules for easy reading and pre-defined style variants. */
/* */
/* :Author: Günter Milde, based on html4css1.css by David Goodger */
/* :Id: $Id: plain.css 8397 2019-09-20 11:09:34Z milde $ */
/* :Copyright: © 2015 Günter Milde. */
/* :License: Released under the terms of the `2-Clause BSD license`_, */
/* in short: */
/* */
/* Copying and distribution of this file, with or without modification, */
/* are permitted in any medium without royalty provided the copyright */
/* notice and this notice are preserved. */
/* */
/* This file is offered as-is, without any warranty. */
/* */
/* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause */
/* .. _CSS3: http://www.w3.org/TR/CSS3 */
/* Document Structure */
/* ****************** */
/* "page layout" */
body {
margin: 0;
background-color: #dbdbdb;
}
div.document,
main {
line-height:1.3;
counter-reset: table;
/* counter-reset: figure; */
/* avoid long lines --> better reading */
/* OTOH: lines should not be too short because of missing hyphenation, */
max-width: 50em;
padding: 1px 2%; /* 1px on top avoids grey bar above title (mozilla) */
margin: auto;
background-color: white;
}
/* Sections */
/* Transitions */
hr.docutils {
width: 80%;
margin-top: 1em;
margin-bottom: 1em;
clear: both;
}
/* Paragraphs */
/* ========== */
/* vertical space (parskip) */
p, ol, ul, dl,
div.line-block,
div.topic,
table {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
p:first-child { margin-top: 0; }
/* (:last-child is new in CSS 3) */
p:last-child { margin-bottom: 0; }
h1, h2, h3, h4, h5, h6,
dl > dd {
margin-bottom: 0.5em;
}
/* Lists */
/* ===== */
/* Definition Lists */
/* lists nested in definition lists */
/* (:only-child is new in CSS 3) */
dd > ul:only-child, dd > ol:only-child { padding-left: 1em; }
/* Description Lists */
/* styled like in most dictionaries, encyclopedias etc. */
dl.description > dt {
font-weight: bold;
clear: left;
float: left;
margin: 0;
padding: 0;
padding-right: 0.5em;
}
/* Field Lists */
/* example for custom field-name width */
dl.field-list.narrow > dd {
margin-left: 5em;
}
/* run-in: start field-body on same line after long field names */
dl.field-list.run-in > dd p {
display: block;
}
/* Bibliographic Fields */
/* generally, bibliographic fields use special definition list dl.docinfo */
/* but dedication and abstract are placed into "topic" divs */
div.abstract p.topic-title {
text-align: center;
}
div.dedication {
margin: 2em 5em;
text-align: center;
font-style: italic;
}
div.dedication p.topic-title {
font-style: normal;
}
/* Citations */
dl.citation dt.label {
font-weight: bold;
}
span.fn-backref {
font-weight: normal;
}
/* Text Blocks */
/* =========== */
/* Literal Blocks */
pre.literal-block,
pre.doctest-block,
pre.math,
pre.code {
font-family: monospace;
}
/* Block Quotes */
blockquote > table,
div.topic > table {
margin-top: 0;
margin-bottom: 0;
}
blockquote p.attribution,
div.topic p.attribution {
text-align: right;
margin-left: 20%;
}
/* Tables */
/* ====== */
/* th { vertical-align: bottom; } */
table tr { text-align: left; }
/* "booktabs" style (no vertical lines) */
table.booktabs {
border: 0;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.booktabs * {
border: 0;
}
table.booktabs th {
border-bottom: thin solid;
}
/* numbered tables (counter defined in div.document) */
table.numbered > caption:before {
counter-increment: table;
content: "Table " counter(table) ": ";
font-weight: bold;
}
/* Explicit Markup Blocks */
/* ====================== */
/* Footnotes and Citations */
/* ----------------------- */
/* line on the left */
dl.footnote {
padding-left: 1ex;
border-left: solid;
border-left-width: thin;
}
/* Directives */
/* ---------- */
/* Body Elements */
/* ~~~~~~~~~~~~~ */
/* Images and Figures */
/* let content flow to the side of aligned images and figures */
.figure.align-left,
figure.align-left,
img.align-left,
object.align-left {
display: block;
clear: left;
float: left;
margin-right: 1em;
}
.figure.align-right,
figure.align-right,
img.align-right,
object.align-right {
display: block;
clear: right;
float: right;
margin-left: 1em;
}
/* Stop floating sidebars, images and figures at section level 1,2,3 */
h1, h2, h3 { clear: both; }
/* Sidebar */
/* Move right. In a layout with fixed margins, */
/* it can be moved into the margin. */
div.sidebar,
aside.sidebar {
width: 30%;
max-width: 26em;
margin-left: 1em;
margin-right: -2%;
background-color: #ffffee;
}
/* Code */
pre.code { padding: 0.7ex }
pre.code, code { background-color: #eeeeee }
pre.code .ln { color: gray; } /* line numbers */
/* basic highlighting: for a complete scheme, see */
/* http://docutils.sourceforge.net/sandbox/stylesheets/ */
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}
/* Math */
/* styled separately (see math.css for math-output=HTML) */
/* Epigraph */
/* Highlights */
/* Pull-Quote */
/* Compound Paragraph */
/* Container */
/* can be styled in a custom stylesheet */
/* Document Header and Footer */
footer, header,
div.footer, div.header {
font-size: smaller;
clear: both;
padding: 0.5em 2%;
background-color: #ebebee;
border: none;
}
/* Inline Markup */
/* ============= */
/* Emphasis */
/* em */
/* Strong Emphasis */
/* strong */
/* Interpreted Text */
/* span.interpreted */
/* Title Reference */
/* cite */
/* Inline Literals */
/* possible values: normal, nowrap, pre, pre-wrap, pre-line */
/* span.docutils.literal { white-space: pre-wrap; } */
/* Hyperlink References */
a { text-decoration: none; }
/* External Targets */
/* span.target.external */
/* Internal Targets */
/* span.target.internal */
/* Footnote References */
/* a.footnote-reference */
/* Citation References */
/* a.citation-reference */
</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 -*- -->
<!-- -*- Mode: rst -*- -->
<p><a class="reference external" href="https://pypi.python.org/pypi/PySpice"><img alt="PySpice license" src="https://img.shields.io/pypi/l/PySpice.svg" /></a>
<a class="reference external" href="https://pypi.python.org/pypi/PySpice"><img alt="PySpice python version" src="https://img.shields.io/pypi/pyversions/PySpice.svg" /></a></p>
<p><a class="reference external" href="https://pypi.python.org/pypi/PySpice"><img alt="PySpice last version" src="https://img.shields.io/pypi/v/PySpice.svg" /></a></p>
<p><a class="reference external" href="https://anaconda.org/conda-forge/pyspice/badges/version.svg"><img alt="Anaconda last version" src="https://anaconda.org/conda-forge/pyspice/badges/version.svg" /></a>
<a class="reference external" href="https://anaconda.org/conda-forge/pyspice/badges/downloads.svg"><img alt="Anaconda donwloads" src="https://anaconda.org/conda-forge/pyspice/badges/downloads.svg" /></a></p>
<p><a class="reference external" href="https://travis-ci.com/FabriceSalvaire/PySpice"><img alt="PySpice build status @travis-ci.org" src="https://travis-ci.com/FabriceSalvaire/PySpice.svg?branch=master" /></a></p>
<p><strong>Quick Links</strong></p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/FabriceSalvaire/PySpice/tree/master">Production Branch</a></p></li>
<li><p><a class="reference external" href="https://github.com/FabriceSalvaire/PySpice/tree/devel">Devel Branch</a></p></li>
<li><p><a class="reference external" href="https://travis-ci.com/github/FabriceSalvaire/PySpice">Travis CI</a></p></li>
<li><p><a class="reference external" href="https://github.com/conda-forge/pyspice-feedstock">pyspice@conda-forge</a></p></li>
<li><p><a class="reference external" href="https://anaconda.org/conda-forge/pyspice">conda-forge/pyspice</a></p></li>
<li><p><a class="reference external" href="https://github.com/conda-forge/ngspice-feedstock">ngspice@conda-forge</a></p></li>
<li><p><a class="reference external" href="http://ngspice.sourceforge.net">Ngspice</a></p></li>
<li><p><a class="reference external" href="https://sourceforge.net/p/ngspice/bugs">Ngspice Bug Tracker</a></p></li>
<li><p><a class="reference external" href="https://xyce.sandia.gov">Xyce of Sandia National Laboratories</a></p></li>
</ul>
<div class="section" id="brief-notes">
<h1>Brief Notes</h1>
<p>Thanks to <a class="reference external" href="https://www.discourse.org">Discourse</a>, PySpice now has a <strong>Forum</strong> hosted at <a class="reference external" href="https://pyspice.discourse.group">https://pyspice.discourse.group</a></p>
<p><strong>Disclaimer: PySpice is developed on my free time actually, so I could be busy with other tasks and less reactive.</strong></p>
<p>An issue was found with NgSpice Shared, we must <cite>setlocale(LC_NUMERIC, "C");</cite> see <a class="reference external" href="https://sourceforge.net/p/ngspice/bugs/490/">https://sourceforge.net/p/ngspice/bugs/490/</a></p>
</div>
<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>
<p><em>Note: This site is hosted on my own infrastructure, if the site seems done, please create an issue to notify me.</em></p>
</div>
<div class="section" id="where-to-get-help-or-talk-about-pyspice">
<h2>Where to get help or talk about PySpice ?</h2>
<p>Thanks to <a class="reference external" href="https://www.discourse.org">Discourse</a>, PySpice now has a <strong>Forum</strong> hosted at <a class="reference external" href="https://pyspice.discourse.group">https://pyspice.discourse.group</a></p>
</div>
<div class="section" id="what-are-the-main-features">
<h2>What are the main features ?</h2>
<ul class="simple">
<li><p>support Ngspice and Xyce circuit simulators</p></li>
<li><p>support <strong>Linux</strong>, <strong>Windows</strong> and Mac <strong>OS X</strong> platforms</p></li>
<li><p>licensed under <strong>GPLv3</strong> therms</p></li>
<li><p>implement an <strong>Ngspice shared library binding</strong> using CFFI which support external sources</p></li>
<li><p>implement (partial) <strong>SPICE netlist parser</strong></p></li>
<li><p>implement an <strong>Oriented Object API</strong> to define circuit</p></li>
<li><p>export simulation output to <a class="reference external" href="http://www.numpy.org">Numpy</a> arrays</p></li>
<li><p>plot using <a class="reference external" href="http://matplotlib.org">Matplotlib</a></p></li>
<li><p>handle <strong>units</strong></p></li>
<li><p>work with <strong>Kicad schematic editor</strong></p></li>
<li><p>implement a <strong>documentation generator</strong></p></li>
<li><p>provides many <strong>examples</strong></p></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/releases/latest/installation.html">installation</a> section in the documentation.</p>
</div>
</div>
<div class="section" id="pull-request-recommendation">
<h1>Pull Request Recommendation</h1>
<p>To make it easier to merge your pull request, you should divide your PR into smaller and easier-to-verify units.</p>
<p>Please do not make a pull requests with a lot of modifications which are difficult to check. <strong>If I merge
pull requests blindly then there is a high risk this software will become a mess quickly for everybody.</strong></p>
</div>
<div class="section" id="credits">
<h1>Credits</h1>
<p>Authors: <a class="reference external" href="http://fabrice-salvaire.fr">Fabrice Salvaire</a> and <a class="reference external" href="https://github.com/FabriceSalvaire/PySpice/blob/master/CONTRIBUTORS.md">contributors</a></p>
</div>
<div class="section" id="news">
<h1>News</h1>
<!-- -*- Mode: rst -*- -->
<!-- no title here -->
<div class="section" id="v1-6-0-development-release">
<h2>V1.6.0 (development release)</h2>
<ul class="simple">
<li><p><strong>KiCadTools</strong> a proof of concept module to read KiCad 6
<cite>.kicad_sch</cite> schema file and compute the netlist. <em>This module can
be used to perform any kind of processings on a KiCad schema. It is
actually hosted in the source but could become a standalone
project.</em> For PySpice, it provides a very flexible way to draft a
circuit with the help of KiCad and then generate the netlist without
using the netlist export feature of KiCad. And thus leverage the
writing of fastidious cicruit.</p></li>
</ul>
</div>
<div class="section" id="v1-5-0-production-release-2021-05-15">
<h2>V1.5.0 (production release) 2021-05-15</h2>
<ul class="simple">
<li><p>Support Ngspice up to version 34</p></li>
<li><p>Renamed custom dunders "__dunder__" to "CONSTANT" or "_private" class attributes</p></li>
<li><p>Fixed typo in documentation (thanks to endolith and brollb)</p></li>
<li><p>Add DC temperature sweep support #272 (thanks to Fatsie)</p></li>
<li><p>PWL support improvements #271 (thanks to Fatsie)</p></li>
<li><p>Assign units on creation of temperature-sweep vectors #263 (thanks to ARF1)</p></li>
<li><p>Prevent memory leaks by freeing ngspice command log #260 thanks to ARF1)</p></li>
<li><p>Performance optimization: dispatch multiple alter commands jointly #259 (thanks to ARF1)</p></li>
<li><p>Added spice library support #258 (thanks to Fatsie)</p></li>
<li><p>Allow to specify DC value for PWL #257 (thanks to Fatsie)</p></li>
<li><p>Support for <cite>.nodeset</cite> type initial condition #256 (thanks to Fatsie)</p></li>
<li><p>Fix accuracy problems #254 (thanks to sotw1957)</p></li>
<li><p>Changes to make it easier to use PySpice with a large archive of SPICE models medium diff #249 (thanks to xesscorp)</p></li>
<li><p><cite>Netlist.py</cite>: Fix wrong method when joining parameters during netlist parse #245 (thanks to cyber-g)</p></li>
<li><p>Unit: add Pickle support</p></li>
<li><p>Add Parser code from #136 (thanks to jmgc) but not yet merged</p></li>
<li><p>Unit: add np.mean</p></li>
</ul>
</div>
<div class="section" id="v1-4-3-2020-07-04">
<h2>V1.4.3 2020-07-04</h2>
<p>A huge effort, thanks to @stuarteberg Stuart Berg, has been made to make Ngspice and PySpice
available on Anaconda (conda-forge) for the Window, OSX and Linux platforms. Thanks to the
conda-forge continuous integration platform, we can now run unit tests and the examples on theses
platforms automatically. Hope this will make the software more robust and easier to run !</p>
<ul class="simple">
<li><p>PySpice is now available on Anaconda(conda-forge) as well as a wheel on PyPI</p></li>
<li><p>Added a post installation tool to download the Ngspice DLL on Windows and to check the installation.
It should now simplify considerably the PySpice installation on Windows.</p></li>
<li><p>This tool can also download the examples and the Ngspice PDF manual.</p></li>
<li><p>On Linux and OSX, a Ngspice package is now available on Anaconda(conda-forge).
Note that theses two platforms do not download a binary from Ngspice since a compiler can easily be installed on theses platforms.</p></li>
<li><p>Updated installation documentation for Linux, the main distributions now provide a ngspice shared package.</p></li>
<li><p>Added a front-end web site so as to keep older releases documentation available on the web.</p></li>
<li><p>fixed and rebuilt all examples (but mistakes could happen ...)</p></li>
<li><p>examples are now available as Python files and Jupyter notebooks
(but some issues must be fixed, e.g. due to the way Jupyter handles Matplotlib plots)</p></li>
<li><p>support NgSpice 32 API (no change)</p></li>
<li><p>removed @substitution@ in PySpice/__init__.py, beacause it breaks pip install from git</p></li>
<li><p>fixed some logging spams</p></li>
<li><p>fixed NonLinearVoltageSource</p></li>
<li><p>fixed Unicode issue with °C (° is Extended ASCII)</p></li>
<li><p>fixed ffi_string_utf8 for UnicodeDecodeError</p></li>
<li><p>fixed logging formater for OSX (removed ANSI codes)</p></li>
<li><p>reworded "Invalid plot name" exception</p></li>
<li><p>removed diacritics in example filenames</p></li>
<li><p>cir2py has been converted to an entry point so as to work on all platforms</p></li>
<li><p>updated Matplotlib subplots in examples</p></li>
<li><p>added a unit example</p></li>
<li><p>added a NMOS example (thanks to cyber-g) cf. #221</p></li>
</ul>
</div>
<div class="section" id="v1-4-0-2020-05-05">
<h2>V1.4.0 2020-05-05</h2>
<p>This release is yanked due to broken Windows support.</p>
<ul class="simple">
<li><p>fixed nasty issue with NgSpice shared for <cite>setlocale(LC_NUMERIC, "C");</cite> cf. #172</p></li>
<li><p>fixed <cite>AC AC_MAG AC_PASAE SIN</cite> for new NgSpice syntax</p></li>
<li><p>fixed <cite>initial_state</cite> for <cite>VoltageControlledSwitch</cite></p></li>
<li><p>fixed <cite>LosslessTransmissionLine</cite> #169</p></li>
<li><p>fixed docstrings for element shortcut methods (thanks to Kyle Dunn) #178</p></li>
<li><p>fixed parser for leading whitespace (thanks to Matt Huszagh) #182</p></li>
<li><p>fix for PyYAML newer API</p></li>
<li><p>support NgSpice 31 API (no change)</p></li>
<li><p>added check for <cite>CoupledInductor</cite> #157</p></li>
<li><p>added <cite>check-installation</cite> tool to help to fix broken installation</p></li>
<li><p>added pole-zero, noise, distorsion, transfer-function analyses (thanks to Peter Garrone) #191</p></li>
<li><p>added <cite>.measure</cite> support (thanks to ceprio) #160</p></li>
<li><p>added <cite>log_desk</cite> parameter to <cite>CircuitSimulator</cite></p></li>
<li><p>added <cite>listing</cite> command method to <cite>NgSpiceShared</cite></p></li>
<li><p>added Xyce Mosfet nfin #177</p></li>
</ul>
</div>
<div class="section" id="v1-3-2-2019-03-11">
<h2>V1.3.2 2019-03-11</h2>
<ul class="simple">
<li><p>support Ngspice 30 and Xyce 6.10</p></li>
<li><p>fixed NgSpice and Xyce support on Windows 10</p></li>
<li><p>bug fixes</p></li>
</ul>
</div>
<div class="section" id="v1-2-0-2018-06-07">
<h2>V1.2.0 2018-06-07</h2>
<ul class="simple">
<li><p>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.</p></li>
<li><p>Fixed OSX support</p></li>
<li><p>Splitted G device</p></li>
<li><p>Implemented partially <cite>A</cite> XSPICE device</p></li>
<li><p>Implemented missing transmission line devices</p></li>
<li><p>Implemented high level current sources
<strong>Notice: Some classes were renamed !</strong></p></li>
<li><p>Implemented node kwarg e.g. <code>circuit.Q(1, base=1, collector=2, emitter=3, model='npn')</code></p></li>
<li><p>Implemented raw spice pass through (see <a class="reference external" href="/faq.html">User FAQ</a>)</p></li>
<li><p>Implemented access to internal parameters (cf. <code>save @device[parameter]</code>)</p></li>
<li><p>Implemented check for missing ground node</p></li>
<li><p>Implemented a way to disable an element and clone netlist</p></li>
<li><p>Improved SPICE parser</p></li>
<li><p>Improved unit support:</p>
<ul>
<li><p>Implemented unit prefix cast <cite>U_μV(U_mV(1))</cite> to easily convert values</p></li>
<li><p>Added <cite>U_mV</cite>, ... shortcuts</p></li>
<li><p>Added Numpy array support to unit, see <cite>UnitValues</cite> <strong>Notice: this new feature could be buggy !!!</strong></p></li>
<li><p>Rebased <cite>WaveForm</cite> to <cite>UnitValues</cite></p></li>
</ul>
</li>
<li><p>Fixed node order so as to not confuse users <strong>Now PySpice matches SPICE order for two ports elements !</strong></p></li>
<li><p>Fixed device shortcuts in <cite>Netlist</cite> class</p></li>
<li><p>Fixed model kwarg for BJT <strong>Notice: it must be passed exclusively as kwarg !</strong></p></li>
<li><p>Fixed subcircuit nesting</p></li>
<li><p>Outsourced documentation generator to <a class="reference external" href="https://github.com/FabriceSalvaire/Pyterate">Pyterate</a></p></li>
<li><p>Updated <cite>setup.py</cite> for wheel</p></li>
</ul>
<!-- :ref:`user-faq-page` -->
</div>
<div class="section" id="v1-1-0-2017-09-06">
<h2>V1.1.0 2017-09-06</h2>
<ul class="simple">
<li><p>Enhanced shared mode</p></li>
<li><p>Shared mode is now set as default on Linux</p></li>
</ul>
</div>
<div class="section" id="v1-0-0-2017-09-06">
<h2>V1.0.0 2017-09-06</h2>
<ul class="simple">
<li><p>Bump version to v1.0.0 since it just works!</p></li>
<li><p>Support Windows platform using Ngspice shared mode</p></li>
<li><p>Fixed shared mode</p></li>
<li><p>Fixed and completed Spice parser : tested on example's libraries</p></li>
</ul>
</div>
<div class="section" id="v0-4-2">
<h2>V0.4.2</h2>
<ul class="simple">
<li><p>Fixed Spice parser for lower case device prefix.</p></li>
</ul>
</div>
<div class="section" id="v0-4-0-2017-07-31">
<h2>V0.4.0 2017-07-31</h2>
<ul class="simple">
<li><p>Git repository cleanup: filtered generated doc and useless files so as to shrink the repository size.</p></li>
<li><p>Improved documentation generator: Implemented <code>format</code> for RST content and Tikz figure.</p></li>
<li><p>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>.</p></li>
<li><p>Added the Simulation instance to the Analysis class.</p></li>
<li><p>Refactored simulation parameters as classes.</p></li>
</ul>
</div>
<div class="section" id="v0-3-2-2017-02-22">
<h2>V0.3.2 2017-02-22</h2>
<ul class="simple">
<li><p>fixed CCCS and CCVS</p></li>
</ul>
</div>
<div class="section" id="v0-3-1-2017-02-22">
<h2>V0.3.1 2017-02-22</h2>
<ul class="simple">
<li><p>fixed ngspice shared</p></li>
</ul>
</div>
<div class="section" id="v0-3-0-2015-12-08">
<h2>V0.3.0 2015-12-08</h2>
<ul class="simple">
<li><p>Added an example to show how to use the NgSpice Shared Simulation Mode.</p></li>
<li><p>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.</p></li>
</ul>
</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>