Skip to content

Document tsci simulate analog SPICE simulation command in CLI primer - #31

Open
rushabhcodes wants to merge 2 commits into
tscircuit:mainfrom
rushabhcodes:docs/cli-simulate-analog
Open

Document tsci simulate analog SPICE simulation command in CLI primer#31
rushabhcodes wants to merge 2 commits into
tscircuit:mainfrom
rushabhcodes:docs/cli-simulate-analog

Conversation

@rushabhcodes

Copy link
Copy Markdown
Contributor

What

Adds a dedicated section to CLI.md documenting tsci simulate, which was previously undocumented in the skill primer.

Covers:

  • tsci simulate analog <file> — runs an analog SPICE simulation; notes that analog is currently the only simulate subcommand.
  • Accepted inputs: a tscircuit .tsx source or a circuit JSON file.
  • The pipeline: build circuit JSON → SPICE netlist → ngspice → results table.
  • The --disable-parts-engine flag.
  • Output column reference: Index, time, v(...) node-voltage probes, i(...) current probes, in exponential notation.

Example output

The sample table is real, not hand-written — it was captured by running tsci simulate analog against an RC test circuit, so the column names and formatting match actual CLI output. The section also notes that ngspice prints diagnostic info ahead of the table.

Why

simulate is exposed by the CLI but had no entry in the primer, so agents and users had no reference for the command, its input formats, its flag, or how to read the output table.

Adds a CLI.md section for the previously undocumented `tsci simulate`
command: the `analog` subcommand, accepted inputs (.tsx or circuit JSON),
the build -> SPICE -> ngspice -> table pipeline, the --disable-parts-engine
flag, and an output-column reference. The example table is real output
captured from running the command against an RC test circuit.
Comment thread CLI.md
Example:
```bash
tsci simulate analog index.circuit.tsx
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CC @ShiboSoftwareDev isn't there a way to output a graph svg with this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants