Getting Started
Requirements
Python 3.10 or newer
PySide6 (the Qt 6 bindings)
A working SLiCAP installation (used for symbol metadata and for typesetting parameter values)
For LaTeX-typeset labels and figure export:
pdflatexanddvisvgm(a TeX distribution such as TeX Live). These are optional — without them the editor falls back to plain-text labels.
Launching the editor
From a Python session or Jupyter notebook (the usual way):
import SLiCAP as sl
sl.initProject("My Design")
sl.startSchematic() # blank canvas, full symbol library
sl.startSchematic(config='basic') # blank canvas, basic symbols only
sl.startSchematic(file='sch/mydesign.slicap_sch') # open an existing file
sl.startSchematic(config='basic', file='sch/mydesign.slicap_sch')
The call returns immediately; the editor runs as an independent process alongside the Python session.
config controls which symbols are available in the Place → Symbol menu:
|
Symbol set loaded |
|---|---|
|
All SVG files in the system symbols directory — the complete SLiCAP library. |
|
|
file is the path to a .slicap_sch file to open at startup.
If omitted, the editor opens with a blank schematic.
From the command line (for scripting or desktop shortcuts):
$ python -m SLiCAP.schematic.main # blank, full library
$ python -m SLiCAP.schematic.main --config basic # blank, basic library
$ python -m SLiCAP.schematic.main sch/mydesign.slicap_sch # open file
$ python -m SLiCAP.schematic.main --config basic sch/mydesign.slicap_sch
The main window opens with an empty canvas (or the specified schematic).
Fig. 29 The main window: menu bar, symbol palette (left) and the drawing canvas.
A first schematic in five steps
Place a symbol. Open (shortcut S), pick a resistor and click on the canvas to drop it. See Placing Symbols.
Wire it up. Choose (shortcut W) and click from one pin to the next. Unconnected pins show a small grey marker that disappears once a wire reaches them. See Wiring.
Set values. Double-click a component to open its Properties dialog and enter a value (for example
{R_s}for a symbolic resistance). See Component Properties.Mark source and detector. Use to designate the independent source and the detector.
Save and export. writes the
.slicap_schfile; produces a.cirnetlist for SLiCAP. See Netlist & Export.