The repository¶
quantcore-circuits is Quantcore’s design loop for superconducting-qubit chips. You describe a chip (by drawing it in KLayout, by writing Python, or by giving frequency targets), and the repository builds the layout, checks it, turns it into a lumped circuit, prepares and reads back finite-element simulations, tunes the design toward its targets and exports the mask. It is a thin layer over existing libraries: KQCircuits (geometry, routing, simulation export, AEDT scripts), Qiskit Metal (lumped models), and QuCat, SQcircuit, scqubits and QuTiP (quantisation).
It has four front ends over one design file (design.json): a KLayout plugin, a Python library with the qcc command, a
set of notebooks (five tutorials and over a hundred design notebooks) and a web dashboard. The process is niobium on
sapphire, 650 µm thick, εr 10.25 (quantcore_nb_sapphire_v1, the default). The package imports KQCircuits, which is
GPL-3.0, and is itself public under GPL-3.0-or-later.
To start, read getting started, then the flow and use cases.
Top-level folders¶
Path |
What it holds |
|---|---|
|
The Python library and the |
|
The Quantcore KLayout plugin, a Salt package (plugin) |
|
Source of the dashboard: Vite, React, Tailwind. It builds into |
|
Five tutorial notebooks, from a one-qubit chip to the whole loop (tutorials) |
|
The design notebooks, one folder per group: |
|
The first-run notebooks |
|
These pages (Sphinx and MyST, hosting). |
|
The pytest suite; no GUI or solver needed. |
|
Helper scripts: |
|
Logos (the Quantcore and Circuits wordmarks, light and dark) and the plugin tool icons |
|
|
|
Outputs, git-ignored: layouts ( |
|
The wheel built by |
Top-level files¶
File |
What it is |
|---|---|
|
Short overview, install and quick start |
|
The developer route: checkout, editable installs, tests, conventions |
|
What changed in each release |
|
GPL-3.0-or-later |
|
Package metadata (version 0.0.2, Python 3.11 or later) and the |
Modules and how far they are built¶
done = built and run for real; partial = built, part unverified or missing; export only = solver input is written but never solved. The date and the evidence for each row are on the status page.
Module |
What it does |
Where it lives |
Docs |
Status |
|---|---|---|---|---|
KLayout plugin |
Place, connect and route components in KLayout; the panel runs the whole flow |
|
done |
|
KLive scripting |
|
|
done |
|
PDK |
Stack, die frame, 100 µm pad rule, keep-outs, cheese, junction process |
|
done |
|
Components |
Quantcore, KQC and Metal cells with ports and LOM models |
|
done |
|
Design file |
The |
|
done |
|
Assembly and routing |
Design to KQC chip; Manhattan routes, meanders, hangers |
|
done; edge cases open |
|
Connectivity DRC |
Dangling pins, overlaps, crossings, opens, keep-outs, netlist |
|
done |
|
LOM |
Layout to lumped circuit, LOM simulation, targets to layout |
|
done; model gaps |
|
Simulation export |
Sim-group cut-outs written as HFSS, Q3D, Elmer, Palace jobs |
|
done for Ansys; Elmer and Palace export only |
|
HFSS and Q3D driver |
Renders and solves jobs in AEDT 2024 R1 or later |
|
done with fast settings; no converged run |
|
Runner and queue |
Solves jobs on a lab server |
|
partial; unit tests only |
|
Results |
Parse solver output, fill the LOM, plots |
|
done for AEDT; plots partial |
|
Feedback |
Consensus against targets, surrogates, new revisions |
|
partial; one real FEM loop |
|
Fab export |
Mask file with the QCT layer map |
|
done; wafer and mask assembly missing |
|
Dashboard |
Follows a run in the browser |
|
done |
|
|
Every step from a terminal |
|
done |
|
Notebooks |
Five tutorials and the design notebooks |
|
tutorials done; see the design pages for each chip |
|
Packaging |
A wheel for other machines |
|
partial; never installed fresh |