Installation
PRISM-Q is a Rust library with optional Python bindings. For Python, see Python Bindings:
pip install prism-q
Add the Rust crate to a project with Cargo:
cargo add prism-q # Rayon parallelism + faer SVD (default)
cargo add prism-q --no-default-features # single-threaded, minimal dependencies
cargo add writes the current release into Cargo.toml for you. To pin a
version by hand instead, take it from
crates.io.
Feature flags
| Feature | Default | Enables |
|---|---|---|
parallel | yes | Rayon parallel kernels (≥14 qubits) and the faer SVD path for MPS |
gpu | no | Optional CUDA backend (see the GPU guide) |
distributed | no | Statevector partitioning across ranks (see Capabilities) |
distributed-mpi | no | distributed plus the MPI transport |
The published benchmarks were taken with parallel enabled. Without it, 16+ qubit runs
fall back to single-threaded kernels and are not comparable to the baselines. Disable it
only when you need a minimal-dependency, single-threaded build.
Building from source
git clone https://github.com/AbeCoull/prism-q
cd prism-q
cargo build --release
Running the test suite
cargo nextest run --all-features # unit + integration tests
cargo test --doc --all-features # doctests
cargo clippy --all-targets --all-features -- -D warnings # lint
Use cargo test --all-features if cargo-nextest is unavailable.
--all-features includes distributed-mpi, which needs a system MPI
installation and libclang for its bindgen step. Without those, substitute the
features you actually want, for example --features "parallel gpu".
Next: build Your First Circuit.