Skip to content

Add a Signal Integrity Course and pcb_spice guides; fix tsci simulate usage - #1001

Open
0hmX wants to merge 1 commit into
mainfrom
docs/si-course
Open

0hmX wants to merge 1 commit into
mainfrom
docs/si-course

Conversation

@0hmX

@0hmX 0hmX commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Summary

New pages under Guides → SPICE Simulation, aimed at electrical engineers who are new to tscircuit:

  • Signal Integrity Course (si-course/): an overview plus 22 lessons in three parts.
    • Part 1 · Simple (ngspice): divider, diode I–V, RC step, RC Bode, parameter sweeps, existing circuit guides.
    • Part 2 · Medium (pcb_spice): lumped trace, transmission line, termination, first pcb_spice run, bits and eyes, IBIS drive strength, return-plane distance, vias, crosstalk.
    • Part 3 · Hard: DDR3 on the AM3352 board (one lane, strobe, corners, full byte, routed copper, timing, power).
  • Simulating PCB Traces with tsci simulate: a walkthrough of the AM3352 DQ0 write eye.
  • A Bit's Journey Across the Board: the same walkthrough as an adventure story.
  • command-line/tsci-simulate.md fix: the CLI is tsci simulate <file>. The page documented an analog subcommand that no longer exists. It now also covers --output, --solver-timeout-ms, how the engine is chosen, and return-current.

How the lessons were checked

Every runnable lesson's output comes from a real tsci simulate run (tscircuit 0.0.3104), and each lesson ends with a hand calculation to compare against. The runnable files, plus the synthetic teaching IBIS model used in Part 2, are in tutorial/course of the AM3352 repo: 0hmX/am3352-ddr-track-a-local-dfm-wip-20261007#13. The links in the pages point to that repo's main, so they resolve once that PR merges.

Each lesson carries a status badge:

Status Lessons
✅ Runs today 1–4, 7–14, 16
🟡 Partial 5 (the CLI prints only the nominal sweep run), 15 (crosstalk runs, but the model's trend is non-monotonic; the lesson teaches spotting that)
🟡 Not run yet 18, 21
🚧 Not supported yet 17, 19, 20, 22 (the blocker is linked on each page)

Lesson 6 links to the existing circuit guides.

Pages don't use <CircuitPreview showSimulationGraph>. They show the table or report that tsci simulate actually produces, so readers don't expect a graph from the CLI.

Test plan

  • bun run build passes, with no broken-link warnings on the new or changed pages
  • The dev server compiles all new pages
  • Preview: check the course overview, lessons 10–15 and the CLI page render

🤖 Generated with Claude Code

… usage

- guides/spice-simulation/si-course: a 22-lesson course for EEs new to
  tscircuit, from a voltage divider (ngspice) to DDR3 on a real board.
  Lessons 1-4 and 7-15 show output from real tsci simulate runs, each
  checked against a hand calculation. Lessons that don't run yet say why.
- Simulating PCB Traces with tsci simulate: the AM3352 DQ0 eye walkthrough.
- A Bit's Journey Across the Board: the same walkthrough as a story.
- command-line/tsci-simulate: the CLI is `tsci simulate <file>` (no
  `analog` subcommand); document --output, --solver-timeout-ms, engine
  selection and `return-current`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Nov 6, 2026 5:15pm UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview — 7bf452f1 Deployed Nov 6, 2026 by vercel[bot]
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.

1 participant