Skip to content

Commit

Permalink
ngspice-26: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
h_vogt authored and rlar committed Jan 11, 2014
1 parent b19641d commit 8c99ec7
Show file tree
Hide file tree
Showing 10 changed files with 166 additions and 119 deletions.
21 changes: 14 additions & 7 deletions ANALYSES
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ This file lists the analyses currently implemented into ngspice.
Table of Contents

1 Noise analysis (NOISE)
1.1 Small signal noise
1.2 Transient noise
2 Operating point analysis (OP)
3 Operating point sweep Analysis (DC)
3.1 Enhancements
4 Pole-zero analysis (PZ)
5 Small-Signal distortion analysis (DISTO)
6 Small Signal frequency response analysis (AC)
Expand All @@ -23,6 +24,8 @@ Table of Contents

1 Noise analysis (NOISE)

1.1 Small signal noise

The noise analysis does analysis device-generated noise for the given
circuit. When provided with an input source and an output port, the analysis
calculates the noise contributions of each device (and each noise generator
Expand All @@ -32,6 +35,12 @@ Table of Contents
range - the calculated value of the noise corresponds to the spectral density
of the circuit variable viewed as a stationary gaussian stochastic process.

1.2 Transient noise

Time domain noise analysis during transient simulation is enabled by
providing voltage (and current) source options with white, 1/f and
random telegraph signal noise signals.


2 Operating point analysis (OP)

Expand All @@ -44,11 +53,8 @@ Table of Contents
The operating point sweep analysis determines the values of output
variables while one or two specified independent voltage or current source is
stepped over a user-specified range and the dc output variables are stored
for each sequential source value.

3.1 Enhancements

Added resistance and temperature sweep.
for each sequential source value. Resistance and temperature sweep are
included.


4 Pole-zero analysis (PZ)
Expand All @@ -57,7 +63,8 @@ Table of Contents
ac transfer function. The program first computes the dc operating point and
then determines the linearized, small-signal models for all the nonlinear
devices in the circuit. This circuit is then used to find the poles and zeros
of the transfer function.
of the transfer function. Unfortunately this code is (since its inception in
spice3) not free of bugs.


5 Small-Signal distortion analysis (DISTO)
Expand Down
3 changes: 1 addition & 2 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ releasing patches to the original code through the Internet.

The following people have contributed in some way:

@verbatim
Vera Albrecht,
Cecil Aswell,
Giles C. Billingsley,
Phil Barker,
Steven Borley,
Krzysztof Blaszkowski,
Stuart Brorson,
Mansun Chan,
Wayne A. Christopher,
Expand Down Expand Up @@ -68,7 +68,6 @@ Michael Widlok,
Charles D.H. Williams,
Antony Wilson,
and many others...
@end verbatim

If someone helped in the development and has not been inserted in this list
then this omission was unintentional. If you feel you should be on this list
Expand Down
36 changes: 20 additions & 16 deletions COPYING
Original file line number Diff line number Diff line change
@@ -1,47 +1,51 @@
12345678901234567890123456789012345678901234567890123456789012345678901234567890
Ngspice-25
Copyright (c) 2012,
Ngspice 26
Copyright (c) 2014,
All rights reserved.


Foreword:
Spice's name was originally chosen at the University of California, Berkeley.
As it is the basis of almost all circuit simulators, the major part of the
The name 'Spice' (Simulation Program with Integrated Circuit Emphasis)
was originally chosen at the University of California, Berkeley. The
original Berkeley code is covered under the modified BSD license and
thus sets the basis for all other code added.
As Spice is the basis of almost all circuit simulators, the major part of the
analogue and mixed signals simulation's code is designed to fit with it.
The *spices (generic name for its forks) are heterogeneous in many points due
to the work of researchers, electronic designers, software editors, etc.
The Ngspice team tries to collect work from the different sources and
contribute new functionalities. Thus, the material we manipulate is
heterogeneous in licenses. Keeping the licenses as is, is the way to live with
that diversity. For release 25 as well, we choose not to relicense.
heterogeneous in licenses. Keeping the licenses as is, but also keep it
compatible with the new BSD license, is the way to live with that diversity.

Copyleft is a fundamental question in FOSS development. The choice of a
copylefted contribution, or a non copylefted contribution is an important
choice that should be respected. Ngspice branch as a whole will not be covered
by a specific license. The Ngspice team wants to encourage contributions to
ngspice. We let each new developper choose its position regarding copyleft,
as we respect the position of the former developpers. In order to keep things
ngspice. We let each new developer choose its position regarding copyleft,
as we respect the position of the former developers. In order to keep things
clear ngspice team proposes to follow the following guidelines:

Each piece of code should be kept under its original contributor's license.
As for any project, modifications made in sources covered by a less
restrictive license can be covered by a more restrictive license, such as
GPL. We do not encourage it.
restrictive license can be covered by a more restrictive license than new BSD.
We do not encourage it.

If you feel to add code in a file under a different license than the rest of
the file, please use comments to mark the boundaries of the modification, and
edit the comments at the begining of the file with correct license and
edit the comments at the beginning of the file with correct license and
copyright information.

We encourage restrictive licenses to be chosen only for new functionalities,
written in distinct files, leading to distinct libraries that links depending
written in distinct files, leading to distinct libraries that link depending
on a specific configure flag.

We encourage non proliferation of licenses (e.g. choosing either GPL, LGPL or
new BSD).
We encourage non proliferation of licenses (e.g. choosing either LGPL or
new BSD). GPL is not suitable for code to be directly linked into ngspice,
but may be used in shared object libraries only.

This heterogenous license status makes it difficult to know which license
applies. Please take care of knowing which license aplies to the code you are
This heterogeneous license status requires some effort to keep track on licenses
applied. Please take care of knowing which license applies to the code you are
editing, or conveying and not to commit license infringements, especially to
GPL and LGPL which are quite restrictive.

Expand Down
3 changes: 3 additions & 0 deletions DEVICES
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Table of contents
13.3 HICUM0 Bipolar Model
13.4 HICUM2 Bipolar Model
13.5 Mextram Bipolar Model
14. XSPICE code models

------------------

Expand Down Expand Up @@ -849,3 +850,5 @@ will be updated every time the device specific code is altered or changed to ref
Status: TO BE TESTED

Web site at: http://mextram.ewi.tudelft.nl/ and http://mextram.sourceforge.net/

14. XSpice code models, see ngspice manual chapt. 12
Loading

0 comments on commit 8c99ec7

Please sign in to comment.