psiqdk 2.0.0

PsiQuantum Quantum Development Kit - Comprehensive SDK for quantum algorithm development

PsiQDK

PsiQuantum's Quantum Development Kit: a single meta-package that bundles the core libraries used to write, analyze, and visualize fault-tolerant quantum algorithms. Installing psiqdk pulls in a tested, version-pinned set of components that are known to work together.

Rather than tracking individual versions of Workbench, Algorithms, Bartiq, Visualize, and QREF, you depend on psiqdk and get a coherent stack. Stable releases are validated end-to-end before publication, so upgrading is a single pip install --upgrade.

Install

pip install psiqdk

This installs the latest stable release with every bundled component pinned to a known-good version.

Requirements

• Python 3.11, 3.12, or 3.13
• macOS (universal2: Apple Silicon and Intel), Linux x86_64 (glibc via manylinux, musl via musllinux)
• Windows is not supported; run PsiQDK inside WSL

Optional extras

pip install "psiqdk[all]"        # everything, including optional viz/optimization deps

What's inside

Component	Purpose
psiqdk.workbench	Python interface for writing and simulating quantum programs.
psiqdk.algorithms	Library of reusable quantum algorithms and subroutines (Qubricks).
psiqdk.visualize	Visualizations for circuits and resource estimates in Jupyter / VS Code.
bartiq	Symbolic compiler for quantum resource estimation.
qref	Open interchange format for representing quantum algorithms.

flowchart TB
    PSIQDK[psiqdk]
    PSIQDK --> WB[workbench]
    PSIQDK --> ALG[algorithms]
    PSIQDK --> BQ[bartiq]
    PSIQDK --> VZ[visualize]
    BQ -. uses .-> QR[qref]

psiqdk itself does not expose an importable API. Import components directly:

from psiqdk import workbench, algorithms, visualize
import bartiq
import qref

Verify your install

Run the bundled CLI with no arguments to print the version, Python info, and the status of every pinned component:

psiqdk

A clean install ends with ✓ All dependencies satisfied. and exits 0. A mismatch exits 1 and prints the offending packages with a fix hint.

For just the version (e.g. in bug reports):

psiqdk --version    # or -V

Upgrade

pip install --upgrade psiqdk

PsiQuantum officially supports the current stable release. Stable releases are cut on a regular cadence with aggregated release notes.

Troubleshooting

pip can't find psiqdk

Most common causes:

• Python too old. PsiQDK requires Python ≥ 3.11. Check with python --version.
• Unsupported platform. Windows-native and Linux ARM are not supported. Use WSL on Windows.

psiqdk reports a dependency mismatch

Another package in your environment has pinned a different version of a bundled component. The fastest fix:

pip install --upgrade --force-reinstall psiqdk
psiqdk

If the mismatch persists, find the package holding it back:

pip show psiqdk-algorithms   # Required-by: lists every dependent

Either upgrade/remove that package, or start clean:

python -m venv .venv
source .venv/bin/activate
pip install psiqdk
psiqdk

ImportError after a clean install

Usually a Python version below 3.11 (Workbench's native extensions are not built for older Pythons). Upgrade your interpreter and reinstall in a fresh venv.

Support

• Open an issue on the PsiQDK GitHub repository. Attach psiqdk (the full dependency report) when filing bugs.
• For commercial support, contact PsiQuantum through your organization's designated channel.