vyges-thermal — CLI reference

Generated from vyges-thermal --help. Do not edit by hand — run scripts/gen-cli-reference.sh.

vyges-thermal — steady-state on-chip thermal analysis (floorplan -> temperature)

usage:
  vyges-thermal run   JOB [-o OUT] [--json] [--fail-on-violation]
  vyges-thermal check JOB
  vyges-thermal demo  [-o OUT] [--json]

A JOB is a small declarative `.thermal` file (die + grid + material params +
a `floorplan:` of blocks with placement and power). With per-block leakage and
`leak_alpha_per_c` it runs the electro-thermal coupling loop. The report gives
the peak temperature, the hotspot location, per-block temperatures, and a
PASS/FAIL against `t_limit_c`.

flags:
  -o FILE               write output to FILE (default: stdout)
  --json                machine-readable JSON instead of the text report
  --fail-on-violation   exit 3 if the peak temperature exceeds t_limit_c
  -q, --quiet           suppress non-essential output
  -v, --verbose         extra detail on stderr
  --describe            print a machine-readable JSON description of the command
  -h, --help            show this help
  -V, --version         show version
  --bug-report      file a bug (central: vyges/community)
  --feature-request request a feature (central)
  --sponsor         sponsor Vyges (github.com/sponsors/vyges-ip)
  --star            star this tool on GitHub ⭐

Contract

Generated from vyges-thermal --describe.

thermal

steady-state on-chip thermal analysis (floorplan -> temperature)

Maturity: workflow-validated

run {job}

Consumes: floorplan, power_report

Artifacts: thermal_report (report_path)

Assertion: thermal-within-limit — passes when pass is true

Provenance limitations

• The job names the floorplan and per-block power; input_hash covers the job path and arguments, not their contents.