qslib documentation
qslib is a quantum simulation library for finite lattice models. The project defines physical conventions first, then exposes the same checked objects through Rust, the command line, and Python.
Start here
- Scientific conventions - canonical site order, bits, physical axes, bases, couplings, boundaries, and normalization.
- CLI guide - run the four-site exact and tiny SSE examples.
- Installation - install the command, Rust library, and optional Python wheel.
- API stability review - understand the candidate 1.0 public surface and compatibility rules.
- Python guide - use the
qslib_quantumNumPy binding. - Geometry and interactions - pair-dependent and disordered couplings.
- Operators and models - Hamiltonian signs and model construction.
- Exact methods - basis enumeration, spectra, evolution, and residual diagnostics.
- Observables and statistics - totals, densities, axes, correlations, and uncertainty.
- TDVP - real- and imaginary-time statistics and solves.
- SSE - sign-safe finite-temperature sampling.
- IO - versioned configurations, checkpoints, and trajectories.
- Symmetry - site permutations, characters, and projections.
- Reproducibility - provenance, seeds, checksums, and uncertainty.
- Limitations - finite-system scope and numerical caveats.
- Migration from ncli
- Migration from standalone SSE
API reference
Build the Rust API reference locally with:
RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps --all-features
The generated entry point is target/doc/qslib/index.html. The combined
published site also provides the Rust API reference.
The API reference is generated output and is intentionally not committed to
the source tree.
Architecture and governance
All worked examples in the CLI guide are executed by integration tests. The Python wheel and its contract tests are built separately because Python is an optional foreign-function boundary rather than a dependency of the Rust core.