Installation¶
PsiQDK is published on PyPI as psiqdk. Install it with pip:
This installs the latest stable release, including pinned versions of all core components: Workbench, Algorithms, Visualize, Bartiq, and QREF.
Requirements¶
- Python 3.11, 3.12, or 3.13
- A supported platform (see below)
Supported platforms¶
PsiQDK's native simulation backend is distributed via platform-specific wheels. we currently support the following platforms:
- macOS (universal2: Apple Silicon and Intel)
- Linux x86_64 (glibc, via
manylinux) - Linux x86_64 (musl libc, via
musllinux)
Windows is not officially supported. Windows users should run PsiQDK inside WSL ⧉ on a supported Linux distribution.
Verifying the installation¶
After installing, run the bundled CLI to confirm everything resolved cleanly:
A clean install reports ✓ All dependencies satisfied.. If something else in your environment has pinned a different version of one of the bundled packages, psiqdk will flag the mismatch with a ✗ next to that row and a non-zero exit code. See the CLI page for details.
Note
PsiQDK is a meta-package and does not expose its own importable API. Import the components directly (from psiqdk.workbench import ..., import bartiq, etc.).
Upgrading the PsiQDK¶
You can upgrade the PsiQDK by entering the following command:
Stable releases are cut on a regular cadence. PsiQuantum officially supports the current stable release.