quantcore_circuits.assembly.sidecar

<name>.qcc.json next to every written layout: what the KLayout plugin needs to edit a design in the GUI.

The plugin runs in KLayout’s own Python (pya + stdlib only), so instead of importing quantcore_circuits it reads this file: the design path, every port (position, outward direction, CPW a/b), instance boxes and placements, and the routes as built (sharp node polyline, user waypoints, bend radius, lengths). Coordinates are µm, chip frame.

Attributes

Functions

instance_junction_entry(name, inst, pdk) → dict | None

instances.<name>.junction of the sidecar: the junction the LOM and the eigenmode / driven exports take

instance_results(design[, run_root, layout_path]) → dict

Per-instance results for the plugin panel, from the design's run state (<run_root>/<name>/state.json).

sidecar_dict(result[, layout_path, overlays]) → dict

Sidecar content; overlays adds the fast DRC, the LOM node map and per-instance results (for the plugin).

sidecar_path(layout_path) → pathlib.Path

write_sidecar(result, layout_path) → pathlib.Path

Module Contents

quantcore_circuits.assembly.sidecar.instance_junction_entry(name: str, inst, pdk) → dict | None

instances.<name>.junction of the sidecar: the junction the LOM and the eigenmode / driven exports take (instance_junction()) — {"kind": "JJ" \| "SQUID", "Lj0_nH", "Cj_fF", "flux_phi0", "asym", "Lj_eff_nH", "source"} (Lj0_nH / Lj_eff_nH / source None: no value; "error" when the flux leaves no finite L). None for a component without a junction.

quantcore_circuits.assembly.sidecar.instance_results(design, run_root: str | pathlib.Path = 'build', layout_path: str | pathlib.Path | None = None) → dict

Per-instance results for the plugin panel, from the design’s run state (<run_root>/<name>/state.json).

One entry per dashboard element that is an instance or a route of design (qubits, resonators, feedline, pads): {"kind", "status", "params": [{key, label, value, unit, status, target, source}], "updated", "stale"}. stale is true when the state was computed for another revision of the design (hash differs), so the panel can grey it out. Empty when there is no run yet or the state cannot be read.

quantcore_circuits.assembly.sidecar.sidecar_dict(result, layout_path: str | pathlib.Path | None = None, overlays: bool = True) → dict

Sidecar content; overlays adds the fast DRC, the LOM node map and per-instance results (for the plugin).

quantcore_circuits.assembly.sidecar.sidecar_path(layout_path: str | pathlib.Path) → pathlib.Path
quantcore_circuits.assembly.sidecar.write_sidecar(result, layout_path: str | pathlib.Path) → pathlib.Path
quantcore_circuits.assembly.sidecar.SIDECAR_SCHEMA = 'qcc-sidecar/0.1'