Installation

qslib is currently distributed as source, a Rust workspace, and an optional Python wheel. The release bundle contains the qslib command, API docs, and wheel artifacts when those platform builds are available. Registry publication is still owner-gated, so the commands below distinguish the prepared future install path from the currently available local path.

Third-party installation channels

After an authorized versioned release, the supported package-manager commands will be:

cargo add qslib-quantum --version 1.0.0 --features exact
python -m pip install qslib-quantum==1.0.0

The Rust distribution is named qslib-quantum but its library target remains qslib, so Rust code writes use qslib::.... The Python distribution is also named qslib-quantum, while its collision-safe import is qslib_quantum. The command-line binary is named qslib and is distributed in platform archives attached to the GitHub release. Pin a release version in automated workflows and verify the accompanying SHA256SUMS file before installation.

Before registry publication, a versioned Git dependency is the reproducible Rust fallback:

[dependencies]
qslib-quantum = { git = "https://github.com/lere01/qslib", tag = "v0.1.0", features = ["exact"] }

Use the source-checkout and local-wheel instructions below when the referenced tag or release asset is not yet available.

Run the command locally

From a source checkout with Rust 1.85 or newer:

cargo run --locked -p qslib-quantum-cli -- inspect conventions

For a local optimized binary:

cargo build --locked --release -p qslib-quantum-cli
target/release/qslib inspect environment

Rust library

Add the facade to a Rust application using a local checkout while the v1 crate remains unpublished:

[dependencies]
qslib-quantum = { path = "../qslib" }

Enable only the capabilities needed by the application, such as exact, variational, sse, or io. The public Rust API is linked from the combined Rust API reference.

Python binding

Install a platform wheel from a release bundle with:

python -m pip install qslib_quantum-*.whl

The import name is qslib_quantum; the Python package exposes NumPy-backed exact, observable, and TDVP contracts documented in Python bindings.

Verify an installation

Every release bundle includes SHA256SUMS. Verify the files before use, then run:

qslib inspect conventions --json
qslib conformance self-test --json

The self-test is a one-fixture smoke test. Scientific production runs must also execute the full conformance and model-specific validation suites.