Support & compatibility
Check feature support, compatibility and how to report a problem.
Find the answer you need
Can I rely on this feature?
Check each interface’s support level and limits.
Is my atom-loss circuit supported?
Check decoder-specific inputs, limits, and rejection outcomes.
What changes across versions?
Review compatibility, deprecation, migration, and release-line rules.
This contract covers the RustQEC 0.3 release line. The documentation version
selects the development branch or a stable release; individual crates may have
different patch versions. Package requirements such as rstim >=0.3.1,<0.4.0
apply to that crate.
Support levels
Supported means the documented behavior is checked within its declared limits. Beta means release verification is still pending. Experimental identifies research workflows without a supported-interface promise.
| Surface | Level | Supported boundary |
|---|---|---|
rstim unified CLI and its capability/error envelopes | Supported | Commands and structured error codes advertised by rstim capabilities --format json |
rstim circuit APIs and CLI | Supported | Documented simulator and CLI inputs within command-specific limits; support varies by analysis/export mode |
| Atom-loss envelope decoders | Decoder-specific status below | Loss-visible Z readout circuits; build requirements and tested operating points below |
| Decoder experiments, benchmark harnesses, and optional visualization/research workflows | Experimental | Inputs and methodology are specific to each workflow |
Atom-loss support boundary
The machine-readable support matrix records each decoder's build requirements, circuit limits, applicable revision and expected acceptance or rejection outcomes. Status is verified against published release evidence; verification procedures are in the maintainer reference.
Decoder-specific support table
| Property | envelope-matching | envelope-mle |
|---|---|---|
| Maturity | Beta unless publication verification succeeds | Beta unless publication verification succeeds |
| Build requirement | Default CLI builds | --features ilp or an official native archive |
| Objective | Minimum-weight matching on a loss-conditioned graph (an approximation; optimal ties allowed) | Exact most-likely fault configuration of the declared envelope model |
Mid-SWAP family (midswap fixtures) | Flat memory-Z circuits within the circuit contract; tested operating points are in the resource report. Untested combinations of size/loss points and latency on other machines are unpromised. | The four workload points in MLE Supported scope below |
| Conventional Stim-annotated family | Isolated checked example (pinned fixture only) | Excluded: rejects the pinned fixture as unsupported_circuit (candidate limit) before publishing any output file |
| Per-shot timeout | Rejected (--shot-timeout-ms is MLE-only) | --shot-timeout-ms; timeout stops the batch with decode_timeout (exit 3), writing diagnostic statistics but no predictions |
| Infeasible shot | Not applicable | decode_infeasible (exit 3), diagnostic statistics but no predictions |
| Unsupported input | unsupported_circuit (exit 2), no prediction or statistics files | Same |
MLE Supported scope
Native timed atom circuits can opt into
loss-visible circuit subset v2
using --circuit-subset v2 on both dataset import and decode.
This experimental input extension preserves the original native pulse and
dephasing locations. It does not expand the measured decoder performance or
Supported workload promises below. Omitting the option keeps subset v1.
The MLE scope plan covers Mid-SWAP distance 3:
| Rounds | Loss parameter | Batch shots |
|---|---|---|
| 2 | 0.002 | 1,024 and 16,384 |
| 1 | 0.01 | 1,024 and 16,384 |
The conventional family and unlisted size/loss/batch points are outside the
Supported promise. There is no interpolation or universal timing guarantee.
Out-of-domain inputs can still be accepted; only hard limits such as candidate
count, REPEAT blocks and unsupported instructions guarantee rejection.
The per-shot timeout applies to solving.
Version compatibility
Compatibility, deprecation and release-line rules.
Mid-SWAP migration
Release and regression procedures
Release gates, regression commands, evidence bundles, and tracked publication gaps are maintained separately from the user support contract.
Get help
For installation problems, unexpected results, or documentation questions, use the repository issue tracker. Include your operating system, package version, the command you ran, and a minimal circuit that reproduces the problem.
For CLI reports, include the relevant output from rstim capabilities --format json.