rsinter
rsinter is an experimental parallel sampling, frozen-dataset replay, and
benchmark collection harness for RustQEC decoder comparisons.
Install
The default installation provides the library, benchmark merging, and the
predict-zero benchmark runner. Install a decoder feature to run replay or a
real decoder benchmark. For BP-OSD and MWPM:
For use as a library:
[]
= { = "0.3.0", = ["rbposd-runner"] }
The RustQEC crates used by this release (rstim, rbposd, rmatching,
rilpqec, and qec-ilp-core) are all resolved at version 0.3. Rust 1.88 or
newer is required.
Replay a detector dataset
This complete example creates a one-error detector error model and two b8 detector rows, then decodes them with BP-OSD:
tmp_dir=""
The statistics report num_shots: 2, num_detectors: 1, and
num_observables: 1. The prediction file contains bytes 00 01: the second
shot predicts an observable flip.
The input and prediction files use Stim's b8 convention: each shot is an LSB-first, byte-aligned row. See the full replay workflow for decoder configuration and output details.
Features
Commands remain visible in --help when their feature is disabled and report
the feature required to run them.
| Feature | Capability |
|---|---|
rbposd-runner |
BP-OSD/BP-LSD replay, benchmarks, and bb-circuit-bposd-memory |
rmatching-runner |
MWPM replay and benchmarks |
ilp-runner |
ILP replay and benchmarks; includes native HiGHS build requirements |
plotting |
Plot commands and the surface_code_threshold example; includes native font dependencies |
full |
All runner and plotting features |
gurobi |
Adds the configured Gurobi backend to ilp-runner; HiGHS remains enabled |
From a source checkout, a focused build is:
Use cargo build --locked -p rsinter --features full only when all decoder and
plotting capabilities, including their native build dependencies, are needed.
The benchmark guide describes
the benchmark spec and result formats.
Apache-2.0 licensed; LICENSE is included in the crate.