Installation¶
PsiQDK is published to 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 as platform-specific wheels. Stable wheels are published for:
- 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 verified successfully. If something else in your environment has pinned a different version of one of the bundled packages, --verify will flag the mismatch. 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¶
Stable releases are cut on a regular cadence with aggregated release notes. PsiQuantum officially supports the current stable release.