Documentation

Search documentation

Browse the index below, or search across the documentation.

Start here

• Install with Cargo and run your first detector event — no source checkout needed.
• Native binaries without Rust — installation alternative.
• Development source setup — master workflows.
• Shot Lab — inspect a circuit in your browser.

Task guides

1. Atom loss: from circuit to logical predictions
2. Simulate circuits and sample measurements
3. Extract detector error models (DEM)
4. Decode detector rows with rmatching
5. Save sampling and training data
6. Construct CSS codes and check distance
7. Render circuit diagrams

Concepts and formats

• Measurement, detector event, and logical observable
• b8 bit packing and row sizes
• Atom loss, value bits, and validity masks
• RSMP v1 sample archives
• QP101 JSON format specification

CLI and Rust API reference

CLI help describes the binary you installed. The API links below are pinned to v0.3.0; for development workflows, use the matching source checkout.

Performance, validation, and support

• Find benchmark evidence and reproduction instructions
• Feature support and compatibility
• Documentation and package versions