rustqec-cli
The rustqec command-line application for inspecting and sampling quantum
error-correction circuits, producing datasets, and loss-aware decoding.
Install the versioned command-line package from crates.io:
This package installs only the rustqec executable; dependency crates do not
install their CLIs.
First circuit
The final file contents are shot D0 L0 and error(1) D0 L0. No rstim
executable or source checkout is needed to run this workflow after installation.
Features and support
- Default: circuit inspection/generation/sampling, dataset tools, and
envelope-matching. This dependency selection does not include HiGHS. ilp: adds exactenvelope-mle, compiling the HiGHS solver. Install native C/C++ build tools, CMake, and Clang/libclang before using this feature.- Official native archives include both decoders. Run
capabilities --format jsonon the actual binary to discover its supported choices and error contracts.
Rust 1.88 is the minimum supported compiler. Tested native environments are Ubuntu 24.04 x86_64 and macOS 15 Apple silicon. Decoder acceptance is limited by the support contract; envelope decoding is beta, not a universal decoder for arbitrary loss circuits.
For the separate Stim-style command, use the rstim package and select its
rstim binary. See the getting-started guide
and publishing guide.
Licensed under Apache-2.0; see LICENSE in this package.