01 / GUIDES
Start from the task.
Each guide names menus and commands exactly as the application labels them. A command with a key shows it; Keyboard shortcuts lists them all, and the command palette, Ctrl+K, finds any command by name.
Getting started
Build or open RSpice, create a project or open an example, and run your first simulation.
Schematic entry
Place parts, wire them, build hierarchy and symbols, and check the design.
Simulation setup
Add analyses, review sources, outputs, sweeps and solver options, then run.
Results
Read waveforms and the other result views, measure, compare runs and export data.
Verification
Monte Carlo yield, process corners, tuning, optimization, safe operating area and regression.
Models and PDKs
Point RSpice at model libraries, browse and edit models, and choose corner sections.
Verilog-A
Create or import a Verilog-A module as a cell view, compile it and place it.
Netlists and scripts
Open or write SPICE decks, export netlists, run Python workflows and use the command line.
Troubleshooting
Refused runs, the Problems list, recovery, safe mode and support bundles.
Keyboard shortcuts
Every default key, menu by menu, generated from the application's command registry.
02 / RUNTIME BOUNDARY
One engine behind the command line, the desktop and the browser.
rspice-core parses SPICE netlists, evaluates devices, assembles modified-nodal-analysis systems and runs the analyses. The command line and the desktop and browser application run the same rspice-core code, so a result does not depend on how the run was launched. Where a deck needs physics RSpice does not have, it stops with an error naming the parameter or model level responsible rather than approximating.
egui / wgpu
The native application: eight workspaces covering projects, schematic and symbol design, simulation setup, results, verification, models, netlists and scripts, and stimulus definitions.
WebAssembly
The same application in a browser tab, with simulations in a worker off the page's main thread. Experimental: it needs WebGPU, and phones and tablets are not a qualified target.
Command line
rspice runs decks and studies, checks and inspects them, converts result files and compares them with golden results. Its exit status is the verification contract.
03 / SOURCE BUILD
Build the command line or the application from a checkout.
Signed installers are not published yet. The toolchain is pinned to Rust 1.94 by the repository's rust-toolchain.toml, which rustup picks up on its own.
git clone https://github.com/JaimeHW/RSpice.git
cd RSpice
cargo build --release -p rspice-cli
target/release/rspice --helpcd RSpice
cargo run --release -p rspice-appAdd --features generated-veriloga-catalog to compile in the 43 compact models generated from their Verilog-A sources. At the workspace root a plain cargo build builds the command line and the application; use -p <package> for a tool or --workspace for everything. Use the repository README and CI configuration for the checked-out revision.
04 / ANALYSIS MAP
The analyses a deck or rspice run can request.
The application offers the same families from Simulate › Add analysis…; Simulation setup lists them by the names it uses.
| FAMILY | REQUESTED BY | NOTE |
|---|---|---|
| Operating point & sweeps | .OP .DC .TEMP .STEP .TF .SENS .DCMATCH | Nested two-source DC sweeps, temperature and parameter run axes (a parameter, a device or a DATA= table), transfer function, DC and AC sensitivity, and DC mismatch. |
| Transient & spectral | .TRAN .FOUR .FFT | Adaptive timestep with breakpoint handling, TRNOISE transient noise, and --checkpoint/--resume segmentation. Fourier, THD and FFT spectra post-process a transient. |
| Small-signal frequency domain | .AC .NOISE .PZ .DISTO | Including .AC DATA= and .NOISE DATA= tables; pole-zero; third-order Volterra distortion with harmonic and two-tone intermodulation. |
| Statistical & corners | .MC --monte-carlo --corners | Monte Carlo over operating-point voltages or named .MEAS results per trial (gaussian, uniform or worst case); corners rerun the deck's analyses once per corner from --corner-lib. |
| RF steady state | .HB .PSS .QPSS .ENVELOPE .SP .STB | Harmonic balance; shooting PSS, driven or autonomous; quasi-periodic steady state; envelope over a preceding .HB; S-parameters with Touchstone export; loop-gain stability. |
| Periodic small-signal | .PAC .PXF .PNOISE .PSTB .QPAC .QPXF .QPNOISE | Linearized around the preceding .PSS or .HB, or a .QPSS for the quasi-periodic set; phase noise by Floquet projection; Floquet multipliers for stability. |
| Configured studies | rspice study | Periodic S-parameters, HB S-parameters, HB noise, safe operating area and optimization run as configured studies, from rspice study or the application. |
| Measurement | .MEAS GOAL TOL | Measurements over TRAN, DC, AC and NOISE; GOAL/TOL sets the exit status. |
.TRAN on a BSIM4 deck rests on far more evidence than a periodic-stability run. The application marks envelope, quasi-periodic steady state and its small-signal analyses, large-signal and periodic S-parameters, harmonic-balance noise, transient noise and DC mismatch as preview engines whose results are not for sign-off.05 / INTERFACES
Interface scope.
- Command line:
rspice run,study,check,info,models,compare,convert,health,capabilities,compile-vaandcompletions. Runs write SPICE raw, ASCII raw, CSV, TSV, JSON, HDF5 or VCD, and can emit JUnit or TAP reports and a versioned JSON run summary. The full manual iscrates/rspice-cli/README.mdin the source. - Desktop application:
rspice-app, built with egui and wgpu, with local file access. The guides above describe it. - Browser: the same application compiled to WebAssembly. It is experimental, needs a WebGPU-capable browser, and keeps projects in the browser's storage.
- Python: Tools › Scripts runs Python workflows inside the application, on a Python runtime RSpice manages rather than a system interpreter. The current source has no separate Python or JavaScript binding package.
- Verilog-AMS: one compiler for
.vaand.vamssources. In the application a module is a cell view;rspice compile-vacompiles one on its own.
06 / VALIDATION DISCIPLINE
Validation targets in the source tree.
The workspace contains unit tests per crate, integration suites, oracle-replay fixtures for history-coupled device behavior, and corpus harnesses: ngspice and Xyce alongside GF180MCU, ISCAS85, mixed-signal and paranoia suites. Each ngspice deck runs in a watchdog-supervised process and is compared row by row with ngspice output; the Xyce harness reports unsupported Xyce contracts instead of omitting the deck.
cargo test --release -p rspice-core
cargo test --release -p rspice-conformance --test ngspice_regression
cargo test --release -p rspice-conformance --test xyce_regressionThe validation methodology describes comparison inputs, failure states, and tolerance requirements. The generated validation page publishes source-controlled corpus inventories and any exact-revision CI artifact available to the site build.