quantcore_circuits.assembly.sidecar =================================== .. py:module:: quantcore_circuits.assembly.sidecar .. autoapi-nested-parse:: ``.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 ---------- .. autoapisummary:: quantcore_circuits.assembly.sidecar.SIDECAR_SCHEMA Functions --------- .. autoapisummary:: quantcore_circuits.assembly.sidecar.instance_junction_entry quantcore_circuits.assembly.sidecar.instance_results quantcore_circuits.assembly.sidecar.sidecar_dict quantcore_circuits.assembly.sidecar.sidecar_path quantcore_circuits.assembly.sidecar.write_sidecar Module Contents --------------- .. py:function:: instance_junction_entry(name: str, inst, pdk) -> dict | None ``instances..junction`` of the sidecar: the junction the LOM and the eigenmode / driven exports take (:func:`~quantcore_circuits.lom.fragment.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. .. py:function:: 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 (``//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. .. py:function:: 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). .. py:function:: sidecar_path(layout_path: str | pathlib.Path) -> pathlib.Path .. py:function:: write_sidecar(result, layout_path: str | pathlib.Path) -> pathlib.Path .. py:data:: SIDECAR_SCHEMA :value: 'qcc-sidecar/0.1'