Metadata-Version: 2.4
Name: SLiCAP
Version: 5.2.1
Summary: SLiCAP: more than SYMBOLIC SPICE
Author-email: Anton Montagne <anton@montagne.nl>
License: MIT
Project-URL: Homepage, https://slicap.github.io/SLiCAP_python/
Project-URL: Issues, https://github.com/SLiCAP/SLiCAP_python
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENCE.txt
Requires-Dist: numpy>=2.4
Requires-Dist: sympy>=1.13
Requires-Dist: scipy>=1.14
Requires-Dist: ply>=3.11
Requires-Dist: matplotlib>=3.9.0
Requires-Dist: svgelements>=1.9.6
Requires-Dist: svglib>=1.5.1
Requires-Dist: reportlab>=3.6
Requires-Dist: pytexit>=0.4.0
Requires-Dist: IPython>=8.19
Requires-Dist: docutils>=0.18
Requires-Dist: sphinx>=7.0
Requires-Dist: sphinx-rtd-theme>=1.2.0
Requires-Dist: PySide6>=6.4
Requires-Dist: requests>=2.25
Provides-Extra: hdf5
Requires-Dist: h5py>=3.0; extra == "hdf5"
Dynamic: license-file

# SLiCAP — more than symbolic SPICE

**Analog design is complex.**\
**Systems engineering tells us how engineers solve complex problems.**\
**SLiCAP makes it doable.**

A simulator tells you what your circuit does — *after* you have chosen the
components. SLiCAP tells you what the components must be: it turns a circuit into
**symbolic design equations**, so values follow from your requirements instead of
from guessing and re-simulating.

Since version 5.2 it comes with the **Structured Electronic Design Environment**,
which integrates SLiCAP and NGspice into one workspace. It keeps every design
decision traceable — from the specification, through the budgets, to the final
design report — so you can design **first-time-right**.
```
pip install slicap        # then start the environment with:  slicap
```

## From specification to design report, in one chain

- **Specification.** Functions, performance and cost requirements are written down as
  project data — the reference every later decision is checked against, not a note in
  the margin.
- **Budgeting.** SLiCAP expresses performance and cost as explicit functions of your
  device properties — you allocate each contribution its share of the requirement, and
  solving the expression gives the value that property must have. Noise, DC variance,
  tolerance, matching and temperature drift all budget the same way.
- **Design and verification, one environment.** Create and solve design equations
  with simple, solvable models, and verify your design with NGspice's full device
  models.
- **Report generation.** Create graphs, LaTeX and RST snippets from expressions,
  tables and NGspice simulations. Put them in your LaTeX design documents and
  Sphinx websites, and keep them up to date with one run.

Nothing is locked in: the environment writes a plain Python script you can read,
edit, run from the command line, or import from your own design code — and SLiCAP
works perfectly well without the GUI.

SLiCAP is the tool set behind the open-access book
**[Structured Electronic Design](https://books.open.tudelft.nl/home/catalog/book/162)**
and the [analog electronics courses](https://analog-electronics.tudelft.nl) at Delft
University of Technology.

## What it looks like

![GUI](GUI.png)

## What it can do

Symbolic and numeric analysis of linear, continuous-time circuits: transfer functions
and their polynomial coefficients, poles and zeros, root-locus plots and Routh arrays,
noise and noise integration, DC variance for tolerance, matching and temperature
budgets, inverse Laplace and network solutions.

Feedback circuits are analysed with the **asymptotic-gain model** — loop gain,
asymptotic gain, servo function and direct transfer, each available on its own.
Balanced circuits are converted into their **common-mode and differential-mode
equivalent circuits**, so each mode is designed for what it must do.

Out of all of it come the design equations for bandwidth, frequency response, noise,
dc variance and temperature stability. Hierarchical netlists, parameter stepping, and
NGspice for numeric verification.

**→ Full documentation, tutorials and examples: [slicap.org](https://slicap.org)**

## About

SLiCAP is an open-source Python program by
[Anton J.M. Montagne](https://montagne.nl), created for and used in structured
analog design practice, teaching and research.

**Two companions to install.** [NGspice](https://ngspice.sourceforge.io) is the
verification half of the environment — install it and your design is simulated with full
device models from inside the same project. A TeX distribution (`pdflatex` + `dvisvgm`)
typesets the expressions on your schematics and builds your LaTeX design reports;
without it SLiCAP falls back to plain text — readable, but not what you want in a
document. Sphinx comes with SLiCAP, so design documentation as a website needs nothing
extra.

See [slicap.org](https://slicap.org) for installation details and for building
from source.

## Contributing

Ideas and contributions are welcome — [email us](mailto:anton@montagne.nl).
Found a bug? Please report it on the *Issues* page.
