RSpice

RSPICE / DOCS / NETLISTS AND SCRIPTS

Netlists and scripts.

Work from SPICE text instead of a schematic, keep an editable deck beside the generated one, export netlists, and automate runs with Python, in the application or from the command line.

WORKSPACE
Netlist and script editor, Alt+7
OPEN A DECK
File › Open netlist as project…
SCRIPTS
Tools › Scripts, Ctrl+`
COMMAND LINE
rspice run

01 / OPEN OR IMPORT A DECK

A deck can be the whole project.

  • File › Open netlist as project… (Ctrl+Shift+L; Ctrl+Alt+Shift+L in the browser), or Open SPICE deck… on the start screen, opens a deck as a netlist project. Such a project has no schematic: the Design workspace shows the deck and links to the editor. The project launcher also takes a dropped .cir, .sp, .spice, .net or .ckt file.
  • File › Import › SPICE deck… brings a deck into the open project. Before the project changes, the import shows the file, the dialect it detected, the parser's result and every transformation it would make.
  • In a project with no deck yet, the Netlist and script editor offers New top deck… and Import deck…; no schematic is needed.

02 / THE SOURCE EDITOR

Editing keys for SPICE text.

COMMANDKEYCOMMANDKEY
Find in source…Ctrl+FGo to line…Ctrl+G
Toggle line commentCtrl+/Duplicate lineCtrl+D
Delete lineCtrl+Shift+KRename symbol…F2
Go to definitionF12 desktopFind referencesShift+F12 desktop

Edit › Format document formats the deck, and View › Folding folds and unfolds it. Find and replace searches editable source and the generated references, but replaces only in project-owned source; Rename symbol renames a definition and every indexed reference to it across the project's editable netlists.

03 / GENERATED AND OWNED SOURCE

The schematic's netlist stays read-only.

A schematic project's netlist is generated, read-only and mapped back to the schematic; Simulate › Open generated netlist (Ctrl+L; Ctrl+Alt+L in the browser) shows it. To change what runs, choose Create editable source from generated netlist… and an edit strategy. The editable copy records the revision it was based on and how it follows regeneration.

STRATEGYWHAT YOU OWN
Owned sourceThe complete deck, as an independently editable source revision.
Parameter and option overrideOnly .param, .option and .temp cards; a run composes them with the frozen generated deck.
Include-order overrideInclude and library ordering, keeping the generated circuit and analyses.
Analysis-only deckAnalysis, measurement, save and probe cards, keeping the generated circuit.

Each included file is marked by who owns it: project-owned and editable, or a read-only external reference, vendor source, technology package or standard library. Copy to project makes an include project-owned, so edits apply when the deck runs and are saved with the project.

04 / VALIDATE AND RUN A DECK

Run from the editor.

Validate source checks the deck with all of its includes; an include cannot be validated or run on its own, only through its root deck. Run deck runs it and Stop ends the run. The run strip then shows whether the deck in the editor is byte for byte the one the run executed, and offers Open in Results and Compare, which compares the run's deck with the working revision.

05 / EXPORT A NETLIST

File › Export.

SPICE netlist… and Spectre netlist… export the current generated revision, either as a deck or as a bundle with its dependencies and a checksum manifest. Exporting does not change the project's source.

06 / PYTHON WORKFLOWS

Tools › Scripts.

Tools › Scripts (Ctrl+`) opens the Automation and CI console in the Netlist and script editor. An automation workspace is a set of files: a Python entry point, a YAML run plan, a read-only environment lock, and a TOML manifest of the capabilities the workflow is granted.

  • The console's toolbar has Validate, which checks the workflow with the managed Python runtime, Dry run, and Run workflow and Stop workflow.
  • The inspector lists the permissions the manifest grants: project files, the artifact directory, network access, process spawning and secret logging.
  • Scripts can be debugged: F9 toggles a breakpoint on the active line, and the debugger starts, pauses and continues.
RUNTIMEPython runs and debugging use only the Python runtime RSpice manages. RSpice never falls back to a system interpreter or invents run or debug results.

07 / THE COMMAND LINE

rspice for batch runs and CI.

The command line runs the same engine as the application, and its exit status is the verification contract: 0 is success, 3 is a missed .MEAS goal or a golden mismatch, and other codes name invalid input, unsupported decks and engine failures. Build it as described on the docs index.

shell / rspiceexamples
# Run a deck and print its measurements
rspice run rc_lowpass.sp --meas

# Write results as HDF5 instead
rspice run rc_lowpass.sp -o rc.h5 --format hdf5

# Quiet batch run with a JUnit report and a time budget
rspice run circuit.sp -q --report-format junit --report-file results.xml --timeout 600

# Compare against a golden file
rspice compare results.csv golden.csv --abstol 1e-9 --reltol 1e-6

rspice check validates syntax and connectivity, rspice info prints what a deck contains, rspice convert converts between raw, ASCII raw, CSV, TSV, JSON, HDF5 and VCD, and rspice study plans and runs a versioned study. --spice-dialect chooses ngspice, xyce or best semantics. The full manual is crates/rspice-cli/README.md in the source repository.