Framework catalog
The catalog is a static Rust constant — the single source of truth for what
the setup wizard offers and what a venv rebuild restores. The frontend
fetches it via the framework_status IPC command; it is not the gate
mapping (that lives in the schemas page).
Verbatim from CATALOG at the time of writing:
| id | Label | pip package(s) | Import probe | Group | ~Size (MB) | Recommended |
|---|---|---|---|---|---|---|
qiskit | Qiskit | qiskit qiskit-aer | qiskit | core | 220 | yes |
cirq | Cirq | cirq | cirq | core | 60 | yes |
cuda-q | CUDA-Q | cuda-quantum | cudaq | core | 500 | no |
qsharp | Microsoft QDK (Q#) | qdk | qdk | core | 25 | yes |
ibm-runtime | IBM Quantum Runtime | qiskit-ibm-runtime | qiskit_ibm_runtime | provider | 20 | no |
ionq | IonQ | qiskit-ionq | qiskit_ionq | provider | 15 | no |
braket | AWS Braket | amazon-braket-sdk | braket | provider | 45 | no |
azure | Azure Quantum | azure-quantum | azure.quantum | provider | 30 | no |
quantinuum | Quantinuum (pytket) | pytket-quantinuum<0.26 | pytket.extensions.quantinuum | provider | 35 | no |
The Quantinuum entry pins <0.26 because newer pytket-quantinuum releases
dropped the direct API-token auth the kernel’s provider uses — see the
hardware overview for the
version note and why Azure Quantum is the recommended path to Quantinuum
hardware today.
How it’s used
Section titled “How it’s used”- Setup wizard / install.
framework_installrunspip install --upgrade <pip package(s)>inside the managed venv for each selected id. Multi-package entries (Qiskit) are split on whitespace. Per-framework failures don’t abort the batch — the caller gets a summary. - Detection. “Installed” means the import probe succeeds: the shell
runs
python -c "import <import_name>"with the venv interpreter, one subprocess per entry, on status refresh. - Venv rebuild. When the managed venv is rebuilt (Python < 3.10 — see install & build), the set of importable catalog ids is snapshotted first and re-installed into the fresh venv.
- Groups.
coreentries are quantum frameworks;providerentries are hardware SDKs. The wizard sections the checklist by group.
Note the QDK entry standardizes on the qdk PyPI package — the standalone
qsharp package is a deprecated shim and is deliberately avoided.
The kernel’s own runtime deps (websockets, numpy, keyring) are not in
the catalog — they aren’t optional, and are installed automatically on
every launch if missing.