Create a SLiCAP circuit object

../_images/colorCode.svg

Netlist

SLiCAP accepts SPICE-like netlists as input. Netlists can also be created manually. The SLiCAP syntax slightly deviates from the SPICE syntax; it is described in section Device Models.

Many schematic capture programs can be configured to generate such netlists. SLiCAP comes with symbol libraries for KiCAD, LTspice, gSchem, and Lepton EDA.

Creation of a SLiCAP ciruit object from a schematic file or a netlist file is performed with the instruction ‘makeCircuit()`:

# Import the SLiCAP module in its own namespce:
import SLiCAP as sl
# Create and.or initialize a project:
sl.initProject("myProject")
# Ceate a circuit object (cir) from a schematic or a netlist:
cir = sl.makeCircuit(<path to schematic or netlist>, imgWidth = <number of pixels>)

Netlist files obtain the extension “.cir” and are placed in the ini.cir_path directory. If a file with extension “.cir” is passed to makeCircuit(), no netlist is generated. In that case the circuit object is created from the existing netlist file.

With schematics input files netlister is selected from the file extension and the operating system.

Netlist generation

File Extension

MSWindows netlister

Linux MacOS netlister

.kicad_sch

KiCAD

KiCAD

.asc

LTspice

LTspice

.sch

gschem gnetlist noqsi

Lepton EDA gnetlist noqsi

.cir

Use exsisting netlist

Use exsisting netlist

Drawing size PDF and SVG images are generated only for KiCAD and Lepton EDA schematics. With KiCAD this requires installation of Inkscape.

For a complete description of the function ‘makeCircuit() see makeCircuit.

Below some notes for configuring schematic capture software for working with SLiCAP.

KiCAD

KiCAD is the preferred schematic capture tool for SLiCAP. This is because it works on all platforms and supports generation of PDF and SVG images. Unfortunately KiCAD doesn’t support resizing of the image from the page size to the drawing size. However, Inkscape is used for this purpose.

SLiCAP schematic circuits can be created with KiCAD using symbols from the SLiCAP symbol library: ‘~/SLiCAP/kicad/SLiCAp.kicad_sym’. This library must be added to the KiCAD project.

  1. In the KiCAD schematic editor select: Preferences > Manage Symbol Libraries. This will bring up the ‘Symbol Libraries’ Dialog Box.

  2. There you select the tab: “Project Specific Libraries”

  3. Click add “+” to add the library

  4. Enter a Nickname: “SLiCAP” and select the library path: ‘~/SLiCAP/kicad/SLiCAp.kicad_sym’.

Since this library contains all symbols that can be handled by the netlister, it is good practice to deactivate all built-in libraries. This is done in the ‘Global Libraries’ tab of the ‘Symbol Libraries’ Dialog Box.

LTspice

LTspice can be used for netlist generation. LTspice works with Windows and Linux (under Wine). A version for MAC is also available. The MAC version of LTspice differs from the windows version and netlist generation from within the SLiCAP (python) environment for this version is not supported. Netlists can also be generated manually.

Go to LTspice for the latest version.

For an overview of SLiCAP symbols for LTspice, please view the LTSpice section.

Configure LTspice for use with SLiCAP

SLiCAP circuits should be made with SLiCAP symbols (and not with the default LTspice symbols). LTspice symbols for SLiCAP are placed in the ~/SLiCAP/LTspice folder.

  1. Start LTspice

  2. On the menu bar click Tools > Control Panel. This will bring up the LTspice control panel:

    ../_images/LTspiceControlPanel.png
  3. On this control panel select the Netlist Options tab and select the options as shown below:

    ../_images/LTspiceControlPanelNetlistOptions.png
  4. Then select the Sym. & Lib. Search Paths tab and enter the full path to ~/SLiCAP/ltspice. This directory contains all the SLiCAP symbol definitions (‘.asy’ files) for LTspice:

    ../_images/LTspiceControlPanelSymbolPath.png
  5. Then select the Drafting Options tab and change the font size and deselect the “Bold” checkbox as shown below. If you want, you can also select different colors for your schematics.

    ../_images/LTspiceControlPanelFontSettings.png

gSchem

The open source gSchem package can also be used in conjunction with SLiCAP. SLiCAP symbols for gschem are included in the ~/SLiCAP/gSchem/symbols/ folder.

For an overview of SLiCAP symbols for gSchem, please view the gSchem section.

The use of gschem as front-end for SLiCAP has been tested under Linux and Windows. However, for Linux please use Lepton EDA instead.

An MSWindows installer for gschem can be downloaded from: gEDA-20130122.zip. Netlist generation requires the gnet-spice-noqsi spice netlister. SLiCAP has a built-in instruction for netlist generation with gschem and this netlister.

MSWindows installation of gschem is straightforward: simply extract the downloaded gEDA-20130122.zip archive and run the installer. In the drop down menu of the “Select Components” dialog box select “Program only”, for the rest accept default settings.

The netlister is installed by copying ‘gnet-spice-noqsi.scm’ from the downloaded and extracted archive to: “C:Program Files (x86)gEDAgEDAsharegEDAschemegnet-spice-noqsi”.

You need also need to create or modify the file ‘gafrc’ in the ‘~.gEDA' directory. It should have the following content:

(reset-component-library)
(component-library "C:/Program Files (x86)/gEDA/gEDA/share/gEDA/sym/slicap")

The component library is found in the in the ~/SLiCAP/gschem/symbols/ folder. Create a directory “C:Program Files (x86)gEDAgEDAsharegEDAsymslicap” and copy the component library files to this directory.

If you wish to have a light background you can create or modify the file ‘gschemrc’ in the ‘~.gEDA' directory. Its contents must be:

(load (build-path geda-rc-path "gschem-colormap-lightbg")) ; light background

Be sure you save these two files ‘gafrc’ and ‘gschemrc’ without any file extension.

Lepton-eda

Lepton-eda is a fork of geda-gaf. Please visit https://github.com/lepton-eda/lepton-eda for more information.

For an overview of SLiCAP symbols for lepton-eda, please view the gSchem section in the help file.

After installation of lepton-eda you need to create or modify the file: ‘~/.config/lepton-eda/gafrc’ with the contents:

(reset-component-library)
(component-library "<path to SLiCAP symbol Library>" "SLiCAP")

If you wish to have a light background, you can create or modify the file ‘~/SLiCAP/.config/lepton-eda/gschemrc’ in your home directory with the contents:

(load (build-path geda-rc-path "gschem-colormap-lightbg")) ; light background

Be sure you save these two files ‘gafrc’ and ‘gschemrc’ without any file extension.

SLiCAP uses the gnet-spice-noqsi spice netlister. It is included in the latest version of lepton-eda.

For compact node names (important for use in symbolic expressions) you need to reconfigure the default net name prefix.

This is how it should be done under Linux:

sudo lepton-cli config --system "netlist" "default-net-name" ""

Display schematics on html pages and in LaTeX reports

Scalable Vector Graphics (“.svg”) images are preferred for displaying on HTML pages, while Portable Document Format is preferred for LaTeX reports.

With KiCAD you can create both “.svg” files and “.pdf” files. However, even without page border, images will obtain the page size. Inkscape can be used to resize the image to the drawing size. If installed, creation and resizing of images will automatically be performed with makeCircuit().

With LTspice you can print schematics to a .PDF file using a PDF printer. Printing and rescaling cannot be invoked by SLiCAP.

With gschem running under MSwindows you can write your schematic file to a .PDF file. Printing and rescaling cannot be invoked by SLiCAP.

When running under MSWindows, you can use pdf2svg-1 or pdf2svg-2 for PDF to SVG conversion.

Under Linux and Mac OS you can install ‘psd2svg’ from the package manager.

Alternatively, on all platforms, you can use Inkscape instead. If you import PDF files with Inkscape use the import settings Poppler/Cairo import. With this selection, fonts will be converted to Bezier curves.

Inkscape can also be used to resize images frompage size to drawing size. This is required for correct display on HTML pages (.svg or .png format) or in LaTeX documents (.pdf format).

With gschem running under Linux or Mac OS you can write your schematic file to a .EPS file.

.EPS files can be converted into .PDF files using the epstopdf command.

Ghostscript is an alternative often available in the package manager of Linux distributions. Otherwise Ghostscript versions can be downloaded from: Ghostscript.

With lepton-eda running under Linux you can print to pdf or svg. The image size will be equal to the drawing size and no conversion is necessary.

../_images/colorCode.svg