Skip to content

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:

idLabelpip package(s)Import probeGroup~Size (MB)Recommended
qiskitQiskitqiskit qiskit-aerqiskitcore220yes
cirqCirqcirqcirqcore60yes
cuda-qCUDA-Qcuda-quantumcudaqcore500no
qsharpMicrosoft QDK (Q#)qdkqdkcore25yes
ibm-runtimeIBM Quantum Runtimeqiskit-ibm-runtimeqiskit_ibm_runtimeprovider20no
ionqIonQqiskit-ionqqiskit_ionqprovider15no
braketAWS Braketamazon-braket-sdkbraketprovider45no
azureAzure Quantumazure-quantumazure.quantumprovider30no
quantinuumQuantinuum (pytket)pytket-quantinuum<0.26pytket.extensions.quantinuumprovider35no

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.

  • Setup wizard / install. framework_install runs pip 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. core entries are quantum frameworks; provider entries 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.