Ryan Malloy
844088aa29
Starlight site at docs-site/ following warehack.ing cookie-cutter pattern (3-compose split, Caddy prod stage, Makefile targets). 15 content pages covering simulation engines, waveform viewer, schematics, embedding with postMessage theme sync, and full REST API reference adapted from llms.txt. Blue accent theme matching SpiceBook's application palette. Adds docs link to homepage reference section.
51 lines
2.6 KiB
Plaintext
51 lines
2.6 KiB
Plaintext
---
|
|
title: What is SpiceBook?
|
|
description: Notebook interface for SPICE circuit simulation — write netlists, simulate with ngspice or LTspice, and visualize waveforms in a single document.
|
|
template: splash
|
|
hero:
|
|
tagline: Write SPICE netlists, simulate, and visualize waveforms — all in one document.
|
|
actions:
|
|
- text: Quick Start
|
|
link: /getting-started/quick-start/
|
|
icon: right-arrow
|
|
variant: primary
|
|
- text: Open SpiceBook
|
|
link: https://spicebook.warehack.ing
|
|
icon: external
|
|
variant: minimal
|
|
---
|
|
|
|
import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';
|
|
|
|
## What SpiceBook Does
|
|
|
|
SpiceBook is a notebook interface for SPICE circuit simulation. Each notebook is a sequence of cells — markdown for documentation, SPICE netlists for circuits, and auto-generated schematics and waveform plots for visualization.
|
|
|
|
You write a netlist, run it against ngspice or LTspice, and see the results inline. No file management, no separate plotting tools, no context switching between editor and simulator.
|
|
|
|
<CardGrid>
|
|
<Card title="Dual Engines" icon="setting">
|
|
Choose ngspice (built-in) or LTspice (via [mcltspice](https://mcltspice.warehack.ing)) per notebook. Same netlist format, different solver characteristics.
|
|
</Card>
|
|
<Card title="Waveform Plots" icon="line-chart">
|
|
Transient, DC sweep, and AC analysis results render as interactive SVG plots with an oscilloscope display mode.
|
|
</Card>
|
|
<Card title="Auto Schematics" icon="puzzle">
|
|
SPICE netlists are parsed into circuit diagrams automatically — resistors even render with IEEE zigzag symbols and 4-band color codes.
|
|
</Card>
|
|
<Card title="Embeddable" icon="laptop">
|
|
Any notebook can be embedded on a third-party page via iframe. Viewers can run simulations directly in the embed.
|
|
</Card>
|
|
</CardGrid>
|
|
|
|
## How It Fits Together
|
|
|
|
SpiceBook is part of the [warehack.ing](https://warehack.ing) project family. It pairs with [mcltspice](https://mcltspice.warehack.ing), an MCP server that gives AI assistants access to LTspice simulation — notebooks created by mcltspice are viewable and editable in SpiceBook.
|
|
|
|
<CardGrid>
|
|
<LinkCard title="Quick Start" description="Create a notebook and run your first simulation." href="/getting-started/quick-start/" />
|
|
<LinkCard title="REST API" description="Programmatic access to notebooks, simulation, and rendering." href="/api/overview/" />
|
|
<LinkCard title="Embedding" description="Embed interactive notebooks on any page." href="/embedding/embed-notebook/" />
|
|
<LinkCard title="Engines" description="ngspice vs LTspice — differences and how to choose." href="/simulation/engines/" />
|
|
</CardGrid>
|