qliff
A Clifford stabilizer simulator with support for noisy and mid-circuit measurement-based simulation.
- Clifford stab simulation via the Aaronson–Gottesman tableau
- Noisy sim via stabilizer-channel
decomposition
E = Σ_μ q_μ S_μand stratified importance sampling (arXiv:2512.07304), "nearly as cheap as Pauli noise." - Decoder-ready QEC primitives: detectors, observables, detection-event sampling, a detector error model by Pauli-frame propagation, and exporters (parity-check matrix + priors, matching weights, syndrome/label tensors). These drop directly into MWPM (pymatching), BP, or ML decoders.
- Code factories for surface, toric, color/triangular/kagome, subsystem
(Bacon-Shor, gauge), and qLDPC (hypergraph-product, bivariate-bicycle) families, plus
from_stabilisers/from_gaugesfor arbitrary Pauli codes.
Install
pip install qliff
Docs at plutoniumm.github.io/qliff.
Clifford simulation
from qliff import Simulator
s = Simulator(2).H(0).CX(0, 1)
s.canon() # ['+XX', '+ZZ']
s.peek("ZZ") # +1
s.measure("XX") # (+1, False)
m0, m1 = Simulator(2).H(0).CX(0, 1).M(0, 1) # m0 == m1
Mid-circuit measurement and classical feedback are just Python — the simulator is stateful, so conditionals (teleportation, syndrome correction) need no special API:
s = Simulator(3, seed=0)
s.H(0)
s.H(1).CX(1, 2)
s.CX(0, 1).H(0)
if s.M(1) == 1:
s.X(2)
if s.M(0) == 1:
s.Z(2)
s.peek("__X") # +1
Noise
Build Circuit with gate/noise methods, then sample or estimate.
Circuit.estimate picks the right sampler by default — plain Monte-Carlo when every channel is Pauli, otherwise
stratified importance sampling
from qliff import Circuit
c = Circuit(1)
c.H(0).DEPOLARIZE1(0, 0.1).M(0)
c.sample(1000)
c = Circuit(1)
c.H(0).RZ(0, 0.3)
c.estimate("X", 20000) # ≈ cos(0.3)
c = Circuit(1)
c.X(0).AMPLITUDE_DAMP(0, 0.3)
c.estimate("Z", 60000) # ≈ 2p - 1
Force the variance strategy with c.estimate(obs, shots, stratify=False) (flat) or stratify=True
(stratified), or drive the sampler directly: from qliff.noise import Sampler, then
Sampler(c).expect(obs, shots, stratify=True). Add a custom channel by subclassing
qliff.noise.Channel and dropping it in with c.noise(ch, q).
For deep-tail logical error rates where plain Monte-Carlo needs prohibitively many shots,
from qliff.noise import SplittingEstimator runs a multilevel-splitting (subset-sampling)
estimator that reaches the far tail with orders of magnitude fewer decodes.
Quantum error correction
qliff.qec ships code-circuit generators, so you can go straight to a logical-error-rate
curve. Alongside rotated_surface_code there are unrotated_surface_code, toric_code,
repetition_code, the color family (color_code, hex_color_code, triangular_code,
kagome_code), subsystem codes (bacon_shor_code, from_gauges), and qLDPC codes
(hypergraph_product_code, bivariate_bicycle_code); from_stabilisers builds a full
memory circuit from an arbitrary Pauli stabiliser set. Any circuit's detectors and
observables are declared with c.detector(...) / c.observable(...), then turned into
decoder inputs:
from qliff.qec import rotated_surface_code, logical_fidelity
from pymatching import Matching
c = rotated_surface_code(5, 5, 0.01) # distance, rounds, p (square d x d patch)
dem = c.dem()
H, priors, obs_matrix = dem.check_matrix()
m = Matching.from_check_matrix(
H,
weights=dem.weights(),
faults_matrix=obs_matrix
)
dets, flips = c.detector_sampler().sample(20000)
fidelity = logical_fidelity(m.decode_batch(dets), flips)
Extending
Everything you'd customize lives in Python. Add a noise channel by subclassing
qliff.noise.Channel and returning its stabilizer-channel branches; plug in a custom
sampler or observable; export the DEM to whatever decoder you like. The Rust core stays a thin,
fast tableau engine.
Develop
./do develop # build rust core
./do test
./do lint
./do bench
./do build # all wheels (macOS/Linux/Windows, x86_64 + arm) + sdist, no upload
./do deploy # publish what `build` made to PyPI (no rebuild)
cd docs && npm run build && npm run deploy # docs site -> GitHub Pages
License
MIT
If you are a company using this, please get a grad student to help you with issues. If you are a grad student, please feel free to email me :)
Release files for qliff 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qliff-0.3.0.tar.gz | 115.0 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| qliff-0.3.0-cp311-abi3-win_arm64.whl | CPython 3.11 | abi3 | Windows ARM64 | Details |
| qliff-0.3.0-cp311-abi3-win_amd64.whl | CPython 3.11 | abi3 | Windows x86-64 | Details |
| qliff-0.3.0-cp311-abi3-manylinux_2_28_x86_64.whl | CPython 3.11 | abi3 | Linux glibc 2.28+ x86-64 | Details |
| qliff-0.3.0-cp311-abi3-manylinux_2_28_aarch64.whl | CPython 3.11 | abi3 | Linux glibc 2.28+ ARM64 | Details |
| qliff-0.3.0-cp311-abi3-macosx_11_0_x86_64.whl | CPython 3.11 | abi3 | macOS 11.0+ x86-64 | Details |
| qliff-0.3.0-cp311-abi3-macosx_11_0_arm64.whl | CPython 3.11 | abi3 | macOS 11.0+ ARM64 | Details |
Total release size: 2.8 MB
Release files / qliff-0.3.0.tar.gz
| Download URL | qliff-0.3.0.tar.gz |
|---|---|
| Size | 115.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4ec7e895ac44b03c9874b75202f756a851fe6c4ed07625161000a61cce674f25
|
|
BLAKE2b-256 checksum How to use checksums |
b1be3a15c0f11fc06fe37d15348474e25dbde74b953041db144de96cf3f4d42f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
Release files / qliff-0.3.0-cp311-abi3-win_arm64.whl
| Download URL | qliff-0.3.0-cp311-abi3-win_arm64.whl |
|---|---|
| Size | 355.0 kB |
| Tags | CPython 3.11 Windows ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
e80dd2d555ccde78c55aa29accdb17beb1f51599f67ca89eda87c8378037d361
|
|
BLAKE2b-256 checksum How to use checksums |
19093f1b788d652ae88b218886361b477291f425d95980e0fb34d46ae9ee5d23
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
Release files / qliff-0.3.0-cp311-abi3-win_amd64.whl
| Download URL | qliff-0.3.0-cp311-abi3-win_amd64.whl |
|---|---|
| Size | 374.5 kB |
| Tags | CPython 3.11 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
a8dd1c84e32317ec2bc961765462f8a2c428f9847f3454d67e9de5ed78f10f17
|
|
BLAKE2b-256 checksum How to use checksums |
cfa30cebea1bb662db9930d821b97ddb7681e69d36936477b3f57c1856db8b63
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
Release files / qliff-0.3.0-cp311-abi3-manylinux_2_28_x86_64.whl
| Download URL | qliff-0.3.0-cp311-abi3-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 501.0 kB |
| Tags | CPython 3.11 Linux glibc 2.28+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
50c85f19884e26a7d9be3fec68e42ad0cafe101d9261c69463ab139745b78d1a
|
|
BLAKE2b-256 checksum How to use checksums |
a3729b2382f5399413004faca9b34e47fc3a6ef8b6a1621a734bc7d75a162a75
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
Release files / qliff-0.3.0-cp311-abi3-manylinux_2_28_aarch64.whl
| Download URL | qliff-0.3.0-cp311-abi3-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 492.4 kB |
| Tags | CPython 3.11 Linux glibc 2.28+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
b390efafcb496d339b1124cd8f1ef3fc9f5990e0a5aeb3e4edc8938ca19dbac1
|
|
BLAKE2b-256 checksum How to use checksums |
ed581f9ef39c6876823f010127df414b66374540d4a6866016a489045c52c1a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
Release files / qliff-0.3.0-cp311-abi3-macosx_11_0_x86_64.whl
| Download URL | qliff-0.3.0-cp311-abi3-macosx_11_0_x86_64.whl |
|---|---|
| Size | 470.9 kB |
| Tags | CPython 3.11 abi3 macOS 11.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
f0f4e608742c66fcbeac5f0766ac4efaeb157c3d7b8cfa8ce90f6437ffb19cc3
|
|
BLAKE2b-256 checksum How to use checksums |
e66a7a9f819712f7a7873ae2c8fa029f250d08b9392c6241f131a7c653f92330
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|
Release files / qliff-0.3.0-cp311-abi3-macosx_11_0_arm64.whl
| Download URL | qliff-0.3.0-cp311-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 447.7 kB |
| Tags | CPython 3.11 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
753092cf439f95d1f8a5749fc6e14a7636637b0658e0266edf8303ce4827eb0b
|
|
BLAKE2b-256 checksum How to use checksums |
09cc38e99825626922c135d34fec004ed3ed1500bf4e7fd3ab86d6a6096310f6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.3
|