quchip.chip.describe

Human-readable text summaries — the describe() surface.

This is a view layer: it renders what the user built (devices, couplings, control wiring, scheduled pulses) — or what a transform derived, e.g. an eliminate() fold report — as a sectioned plain-text report. It never computes physics beyond ordinary arithmetic on already-derived quantities, and never concretizes a traced value for anything but display — tracers render as <traced> even on this debugging surface.

Units come from the declarative parameter() metadata (unit=), so extension authors who declare units get correct describe() output for free.

Functions

describe_chip(chip)	Sectioned plain-text report of a chip's composition.
describe_elimination(result)	Human-readable fold report for eliminate().
describe_sequence(seq)	Timeline table of a sequence's pulses.
format_value(value)	Render one parameter value compactly; traced values stay symbolic.

quchip.chip.describe.format_value(value)

Render one parameter value compactly; traced values stay symbolic.

Parameters:

value (Any)

Return type:

str

quchip.chip.describe.describe_chip(chip)

Sectioned plain-text report of a chip’s composition. See Chip.describe().

Parameters:

chip (Chip)

Return type:

str

quchip.chip.describe.describe_sequence(seq)

Timeline table of a sequence’s pulses. See QuantumSequence.describe().

Parameters:

seq (QuantumSequence)

Return type:

str

quchip.chip.describe.describe_elimination(result)

Human-readable fold report for eliminate().

Every fold stated explicitly, before -> after: per-survivor freq (and T1 when either side carries one), the emitted/upgraded exchange edge with its Yan-formula tag, the ZZ line (a placeholder under method="sw", the exact residual under method="exact"), any control-line retarget, the per-coupling validity verdict, and the dropped-physics summary. See describe().

Parameters:

result (EliminationResult)

Return type:

str