Python library¶
quantcore_circuits is the Python package behind everything else in this repository: the command line qcc, the
KLayout plugin and the dashboard all call it. You use it directly when you design in a script or a notebook, or when
you want to change a step of the flow. The package is a thin layer over KQCircuits (geometry, routing, solver export),
Quantum Metal (LOM) and the quantisation libraries.
Start with the Designer API; it covers most of what a script needs. The table below says what each
part of src/quantcore_circuits/ is for.
Package map¶
Part |
What it is for |
Main entry points |
Page |
|---|---|---|---|
|
Build a chip in Python, live in KLayout |
|
|
|
The |
|
|
|
The component library: Quantcore cells, the KQC and Quantum Metal registry, wafers and fab export |
|
|
|
Flip-chip and TSV designs: cells, faces, per-face DRC, multi-face sim export |
|
|
|
The Quantcore process: stack, layers, die frame, keep-outs, cheese, junction process |
|
|
|
|
|
|
|
Route plans into waveguides and meanders, with length fixing |
|
|
|
Layout to lumped circuit, LOM simulation, targets to layout |
|
|
|
The |
|
|
|
Parameter extraction: Metal LOM, pyEPR, scqubits, QuCat, SQcircuit, QuTiP; results parsing and store |
|
|
|
Sim groups, job export (Q3D, HFSS, Elmer, Palace, Sonnet), the AEDT driver, runners |
|
|
|
The analysis half of the loop: consensus, surrogate, proposals, new revision |
|
|
|
The plugin’s Simulate, Results and Fab steps as functions |
|
|
|
klive client, design file watcher, headless and GUI snapshots |
|
|
|
The dashboard server and the run state it shows |
|
|
|
Plot helpers and PlotSpec builders shared with the dashboard |
|
|
|
Extension points for extra solvers and analyses (Python entry points) |
|
|
|
The |
|
The full list of functions and classes is in the Python API reference.