Skip to content

docs: energy figures + Mermaid pipeline in the README - #7

Merged
chessai merged 1 commit into
masterfrom
readme-figures
Aug 4, 2026
Merged

docs: energy figures + Mermaid pipeline in the README#7
chessai merged 1 commit into
masterfrom
readme-figures

Conversation

@chessai

@chessai chessai commented Aug 4, 2026

Copy link
Copy Markdown
Owner

Add graphics to README, generated from the energy model

Figures (all from real repo data)

  • CPU money plot (docs/img/cpu-money-plot.svg): energy per TISC step vs power-clock ramp, reversible curves sliding below the flat CMOS 1/2 CV^2 floor. Reproduces offline from the committed rung-0 chardb.
  • sky130 three-family (docs/img/sky130-money-plot.svg): real SkyWater sky130 PDK via ngspice: adiabatic-TG (slope ~-0.94), pFAL (falls-then-floors), static CMOS (flat).
  • Per-benchmark energy (docs/img/benchmark-energy.svg): reversible vs CMOS-equivalent for fib/adder at a fixed ramp (~26x and ~43x).

Mechanism

  • New zero-dependency generator crates/theseus-tisc/examples/readme_figures.rs: a hand-rolled SVG log-log/bar emitter fed by cpu_money_plot / money_plot_rung / rom_program_energy. No new crate deps.
  • README: ASCII pipeline replaced with a Mermaid diagram; new Energy section embeds the three figures.

Regenerate: cargo run -p theseus-tisc --example readme_figures (sky130 fig needs the .#char shell).

Verified: clippy --all-targets 0 warnings, fmt clean, SVGs valid XML.

Spice up the README with real, reproducible graphics:

- new zero-dependency figure generator (crates/theseus-tisc/examples/
  readme_figures.rs): a hand-rolled SVG log-log/bar chart emitter fed by
  the real energy APIs. No new crate deps.
- docs/img/cpu-money-plot.svg -- the headline: energy per TISC step vs
  power-clock ramp, reversible curves sliding below the flat CMOS 1/2 CV^2
  floor (offline from the committed rung-0 chardb).
- docs/img/sky130-money-plot.svg -- the three device families on the real
  SkyWater sky130 PDK via ngspice (adiabatic-TG slope ~-0.94, pFAL
  falls-then-floors, CMOS flat).
- docs/img/benchmark-energy.svg -- per-program reversible vs CMOS-equivalent
  energy (fib, adder) at a fixed ramp.
- README: replace the ASCII pipeline with a Mermaid diagram; add an Energy
  section embedding the three figures.

Regenerate: cargo run -p theseus-tisc --example readme_figures
(sky130 fig needs the .#char shell: ngspice + sky130 PDK).
@chessai
chessai merged commit 8902e8e into master Aug 4, 2026
2 checks passed
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