Kessetsu Documentation
On this page
Simulate analog and mixed-mode circuits with real Ngspice, check engineering requirements with clear PASS/FAIL results, and generate connectivity-verified schematics from standard SPICE netlists or readable .kess circuits.
You can use Kessetsu in three ways, all powered by the same deterministic Rust Core:
- Interactive Web Hub: Open the browser workspace with zero installation or account.
- AI Agents via MCP (
kess mcp): Installkessand registerkess mcpin Claude Code, Claude Desktop, Cursor, or Windsurf so your AI agent can compile, simulate, verify requirements, and render schematics through native tools. - Local CLI (
kess test): Run ERC, simulations, parameter studies, and exports directly from your terminal or CI pipeline.
Choose where to start
| What brings you here? | Recommended path |
|---|---|
| New to Kessetsu? | Follow the 5-minute first circuit tutorial in your browser—no installation or account required. |
Already have a SPICE netlist (.cir, .sp)? |
Use SPICE netlist import and direct use to simulate, render a schematic, or convert an existing netlist. |
| Connecting an AI coding agent (Claude, Cursor, VS Code)? | Install kess and read the Agent design workflow (MCP & CLI). |
| Looking for syntax, components, or CLI commands? | Jump to the Language reference, Supported components and limits, or CLI & MCP reference. |
Getting started
- Tutorial: build your first circuit, run AC/transient simulation, and verify its frequency response.
- Web Hub guide: workspace views (
Schematic | Simulation | Split), interactive plots, SPICE converter, exports, and sharing. - SPICE netlist import and direct use: check, test, render, export, or convert supported Ngspice netlists without rewriting them from scratch.
- Why Kessetsu?: how executable requirements and automatic schematics complement SPICE and desktop EDA tools.
AI agents and workflows
- Agent design workflow (MCP & CLI): connect an AI agent via
kess mcpor JSON CLI using locked.kessreqrequirement contracts, ERC, simulation, and schematic handoff. - Cookbook: practical design recipes, reusable module blocks, closed-loop agent tasks, and device models.
- Parameter studies: multi-condition sweeps across component tolerances, loads, and temperatures.
Research and data validation
- Research data: local CSV mapping, residual evidence, and scalar comparisons against simulated traces.
- Finite parameter fitting: calibration-only candidate selection with separate holdout validation.
- Portable research packages: bundle exact study evidence, permitted dependencies, and reproducible rerun instructions.
- Python and Jupyter: inspect simulations, parameter studies, and research evidence in Python.
- Memristor pulse protocol: a reproducible threshold-model study with convergence and held-out stimulus checks.
Reference
- Language:
.kesscomponents, pins, units, parameters, and reusable modules. - CLI & MCP: commands,
kess mcptool server, overrides, JSON schemas, file safety, and exit codes. - Simulation and assertions: OP, DC, AC, and transient analyses with
PASS/FAILrequirement syntax. - Engineering measurements: metric definitions, arguments, and units.
- Device models: built-in generic models, local manufacturer
.lib/.modbindings, and provenance. - Export formats: SVG, PNG, PDF, Schematic JSON, SPICE, KiCad, LTspice, BOM CSV, and Handoff JSON.
- Components and simulation limits: what is modeled and what is out of scope.
Help and updates
- Troubleshooting: diagnostics, browser storage, Ngspice setup, and installation help.
- Changelog: versioned features, fixes, and migration notes.
- Report an issue: include the version, a minimal reproducible circuit, and the diagnostic, without private model files.
- Security reporting and license.
Simulation results describe the supplied circuit, models, and conditions; they are not a guarantee of physical hardware performance. Each reference explains relevant assumptions.
For source contributions, read CONTRIBUTING.md and the architecture rules. Product planning and operational records are maintained separately; this documentation focuses on using and extending the released product.