API reference¶
Generated from the docstrings in python/qsimlab.
The normative contract (conventions, error types, threading and stability guarantees) is the
API contract; where the two disagree, the contract wins and the docstring is a bug.
| Module | What it holds | Status |
|---|---|---|
qsimlab.circuit |
Circuit builder, gate set, instructions |
stable |
qsimlab.sim |
simulate, requests (statevector, amplitudes, samples, expectation), results, budgets, noise |
stable |
qsimlab.errors |
the QsimError hierarchy |
stable |
qsimlab.interop |
conversion to and from Qiskit, Cirq, Stim and OpenQASM 2 | stable |
qsimlab.qec |
memory circuits, detector sampling, error models, decoders | provisional |
qsimlab.shor |
factoring runs, gate-level oracle circuits, resource counts, cost laws | provisional |
qsimlab.analysis |
magic, stabilizer rank, simulability, monitored dynamics | provisional |
Provisional modules may change between minor versions; see ยง7 of the contract.