The v0.3.3 release published the previous rustqec CLI and a separate rstim
CLI. The development checkout combines both command sets in the rstim
package. The unified CLI has not yet been published to crates.io, so install
it from this checkout:
cargo install --locked --path rstim --forceThe install creates one executable, rstim. It includes circuit simulation,
SVG rendering, structured circuit and dataset operations, decoding, capability
discovery, and the Shot Lab viewer by default. Add --features ilp --force
for exact envelope MLE after installing native solver build prerequisites.
The publication allowlist is tools/crates_io_packages.json. Its dependency
order places qec-ilp-core, qec-code, and rmatching before rstim, which
has optional dependencies on them. Independent decoder and experiment crates
follow. rustqec-cli is no longer a workspace or publication package.
renvelope remains a separate research API with publish = false. The
WebAssembly UI adapter, benchmark bridge, and matching benchmark tools are also
unpublished. Rust library consumers can select the narrow feature set they need
with default-features = false.
For a complete Rust library example, see
examples/rust-consumer.
The code/model libraries and standalone decoders keep narrow defaults. rstim enables its CLI by default; library-only consumers can use default-features = false. rsinter installs its harness CLI but requires explicit decoder
features; rilpqec always builds HiGHS. Choose optional capabilities explicitly:
| Package | Feature | Enables |
|---|---|---|
rstim |
unified-cli |
Structured circuit, dataset, decoding, and capability commands |
rstim |
cli |
Simulator commands and executable |
rstim |
ilp |
Exact envelope MLE with HiGHS |
rstim |
codegen-css |
CSS circuit generation using qec-code |
rstim |
shot-viewer |
Local viewer server and embedded web resources |
qec-code |
cli |
Command-line parsing and executable |
qec-code |
distance-ilp-highs |
Exact distance with the HiGHS backend |
qec-code |
distance-ilp-gurobi |
Exact distance with the Gurobi backend |
qec-ilp-core |
highs |
Native HiGHS backend |
qec-ilp-core |
gurobi |
Separately configured Gurobi backend |
rsinter |
rbposd-runner, rmatching-runner |
BP and matching decoder runners/replay |
rsinter |
ilp-runner |
ILP runner/replay through rilpqec and HiGHS |
rsinter |
plotting |
Plot generation |
rilpqec |
gurobi |
Adds Gurobi support; HiGHS remains included |
The default rstim installation enables unified-cli, codegen-css, and
shot-viewer. Library users can call shared operations without command-line
argument parsing by disabling default features.
Viewer files remain in the .crate archive so the optional feature works after
installation; disabling the feature prevents compiling the viewer module, not
downloading those package files. The browser WASM adapter uses the minimal library.
Missing solver backends return explicit errors; importing ILP model types alone
does not compile a solver. Actual Gurobi runtime and license validation were not
performed for v0.3.0.
rsinter now defaults to its harness without optional runners or plotting.
Choose rbposd-runner, rmatching-runner, ilp-runner, or plotting; use full
for the previous complete research environment. The full CI and benchmark bridge
explicitly enable the features they test. Run the standard workspace suite with CLI, CSS, viewer, and HiGHS enabled with:
make testRun standalone worker tests with cargo test -p rstim --features benchmark-tools.
All eight first-batch packages start at 0.3.0. Under
tools/release_version_policy.json, subsequent patches can be published
independently within the same major/minor series: fixing only rilpqec may
produce rilpqec 0.3.1 while the other packages remain at 0.3.0. Compatible Cargo
requirements such as version = "0.3.0" accept those patches. A coordinated
0.4.0 release moves the public series together; unchanged crates do not need
republishing for a 0.3.x patch. The repository tag records a tested snapshot,
with no package ahead of the tag and at least one package matching its version.
Each repository release uses a new tag; changed packages can adopt that tag's
patch number while unchanged packages stay put. Individual packages may
therefore skip patch numbers.
Historical v0.2.1 tags keep their original four-package synchronization rule.
rbposd is a solver-free matrix decoder. rilpqec accepts rstim DEMs and
builds a native ILP solver. rsinter joins the simulator to optional decoders,
so publishing its optional dependencies first is necessary even for a slim
installation. Together these packages cover the simulation → decode → collect
workflow; first publication is not an expansion of numerical acceptance claims.
The recommended sampling/replay installation is:
cargo install --locked rsinter --version 0.3.0 --features rbposd-runner,rmatching-runnerFrom this checkout use --path rsinter instead of rsinter --version 0.3.0.
Add plotting for plots, or ilp-runner with native build prerequisites for
ILP decoding. The default CLI explains missing features. See the self-contained
replay quickstart and ILP example.
Run the checked package/consumer workflow in CI and inspect its artifacts:
python3 tools/check_crates_io.py
python3 tools/check_crate_consumer.pyThe first command checks metadata, the publication graph, installation targets,
and package file lists. The consumer check builds the unpacked simulator/decoder example with viewer
assets temporarily absent and verifies model-only libraries without native solvers.
It then validates an isolated default CLI installation, opt-in ILP compilation,
and a separately installed full compatibility CLI serving its packaged viewer.
It runs the shipped tests/examples for all three added packages, checks the slim
rsinter failure message, and verifies actual BP, matching, and ILP replay
predictions plus malformed-input rejection from an installed full CLI. The consumer checker therefore needs the native solver build
prerequisites; default CLI installation itself does not. Neither command uploads a package.
Retain source tests and compile-time fixtures/assets; exclude repository plans,
research outputs, caches, and unrelated development tools from package files.
Build from the reviewed release commit after its required CI checks pass. With Cargo 1.93.1 (the tooling used to verify this candidate), check all eight packages together, including compilation of their packaged sources:
cargo publish --dry-run --locked \
-p qec-ilp-core -p qec-code -p rstim -p rmatching \
-p rbposd -p rilpqec -p rsinter -p rstimSelecting the packages together lets Cargo verify their unpublished dependencies using a temporary local registry. A dry-run of only a downstream package can fail before its upstream crates exist on crates.io. The publishing toolchain can be newer than the library MSRV, which remains Rust 1.88.
This command does not upload. Actual publication is a separate authorized action
using a crates.io account with a verified email and suitable credentials. If
publishing individually, follow the allowlist order and confirm each upstream
package is available before proceeding. After upload, verify cargo install,
the external Rust consumer, crates.io metadata, and docs.rs from a clean
environment using registry dependencies only. Switch the website's installation
entry to the new release only once its packages and native assets are available.
Cargo's publishing guide and dependency guide describe the registry requirements. First publication establishes the crate; subsequent releases can use Trusted Publishing. Credentials never belong in manifests, reports, or Git history.