Pre-release

This release is a pre-release and may not be stable for production use.

Tesseract Decoder

A Search-Based Decoder for Quantum Error Correction.

C++

Installation – Usage – Paper – Help – Citation – Contact

Tesseract is a Most Likely Error decoder designed for Low Density Parity Check (LDPC) quantum error-correcting codes. It applies pruning heuristics and manifold orientation techniques during a search over the error subsets to identify the most likely error configuration consistent with the observed syndrome. Tesseract achieves significant speed improvements over traditional integer programming-based decoders while maintaining comparable accuracy at moderate physical error rates.

We tested the Tesseract decoder for:

Surface codes
Color codes
Bivariate-bicycle codes
Transversal CNOT protocols for surface codes

Features

A* search: deploys A* search while running a Dijkstra algorithm with early stop for high performance.
Stim and DEM Support: processes Stim circuit files and Detector Error Model (DEM) files with arbitrary error models. Zero-probability error instructions are automatically removed when a DEM is loaded.
Parallel Decoding: uses multithreading to accelerate the decoding process, making it suitable for large-scale simulations.
Efficient Beam Search: implements a beam search algorithm to minimize decoding cost and enhance efficiency. Sampling and Shot Range Processing: supports sampling shots from circuits. When a detection error model is provided without an accompanying circuit, Tesseract requires detection events from files using --in. The decoder can also process specific shot ranges for flexible experiment setups.
Detailed Statistics: provides comprehensive statistics output, including shot counts, error counts, and processing times.
Heuristics: includes flexible heuristic options: --beam, --det-penalty, --beam-climbing, --no-revisit-dets, --at-most-two-errors-per-detector, and --pqlimit to improve performance while maintaining a low logical error rate. To learn more about these options, use ./bazel-bin/src/tesseract --help
Visualization tool: open the viz directory in your browser to view decoding results. See viz/README.md for instructions on generating the visualization JSON.

Installation

Tesseract relies on the following external libraries:

argparse: For command-line argument parsing.
nlohmann/json: For JSON handling (used for statistics output).
Stim: For quantum circuit simulation and error model handling.

Build Instructions

Tesseract uses Bazel as its build system. To build the decoder:

bazel build src:all

Running Tests

Unit tests are executed with Bazel. Run the quick test suite using:

bazel test //src:all

By default the tests use reduced parameters and finish in under 30 seconds. To run a more exhaustive suite with additional shots and larger distances, set:

TESSERACT_LONG_TESTS=1 bazel test //src:all

Usage

The file tesseract_main.cc provides the main entry point for Tesseract Decoder. It can decode error events from Stim circuits, DEM files, and pre-existing detection event files.

Basic Usage:

./tesseract --circuit CIRCUIT_FILE.stim --sample-num-shots N --print-stats

To decode pre-generated detection events, provide the input file using --in SHOTS_FILE --in-format FORMAT.

Example with Advanced Options:

./tesseract \
        --pqlimit 1000000 \
        --at-most-two-errors-per-detector \
        --det-order-seed 232852747 \
        --circuit circuit_file.stim \
        --sample-seed 232856747 \
        --sample-num-shots 10000 \
        --threads 32 \
        --print-stats \
        --beam 23 \
        --num-det-orders 1 \
        --shot-range-begin 582 \
        --shot-range-end 583

Example Usage

Sampling Shots from a Circuit:

./tesseract --circuit surface_code.stim --sample-num-shots 1000 --out predictions.01 --out-format 01

Using a Detection Event File:

./tesseract --in events.01 --in-format 01 --dem surface_code.dem --out decoded.txt

Using a Detection Event File and Observable Flips:

./tesseract --in events.01 --in-format 01 --obs_in obs.01 --obs-in-format 01 --dem surface_code.dem --out decoded.txt

Tesseract supports reading and writing from all of Stim's standard output formats.

Performance Optimization

Here are some tips for improving performance:

Parallelism over shots: increase --threads to leverage multicore processors for faster decoding.
Beam Search: use --beam to control the trade-off between accuracy and speed. Smaller beam sizes result in faster decoding but potentially lower accuracy.
Beam Climbing: enable --beam-climbing for enhanced cost-based decoding.
At most two errors per detector: enable --at-most-two-errors-per-detector to improve performance.
Priority Queue limit: use --pqlimit to limit the size of the priority queue.

Output Formats

Observable flips output: predictions of logical errors.
DEM usage frequency output: if --dem-out is specified, outputs estimated error frequencies.
Statistics output: includes number of shots, errors, low confidence shots, and processing time.

Help

Do you have a feature request or want to report a bug? Open an issue on GitHub to report it!
Do you have a code contribution? Read our contribution guidelines, then open a pull request!

We are committed to providing a friendly, safe, and welcoming environment for all. Please read and respect our Code of Conduct.

Citation

When publishing articles or otherwise writing about Tesseract Decoder, please cite the following:

@misc{beni2025tesseractdecoder,
    title={Tesseract: A Search-Based Decoder for Quantum Error Correction},
    author = {Aghababaie Beni, Laleh and Higgott, Oscar and Shutty, Noah},
    year={2025},
    eprint={2503.10988},
    archivePrefix={arXiv},
    primaryClass={quant-ph},
    doi = {10.48550/arXiv.2503.10988},
    url={https://arxiv.org/abs/2503.10988},
}

Contact

For any questions or concerns not addressed here, please email quantum-oss-maintainers@google.com.

Disclaimer

Tesseract Decoder is not an officially supported Google product. This project is not eligible for the Google Open Source Software Vulnerability Rewards Program.

Metadata

Release files for tesseract-decoder 0.1.1.dev20250730020326

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for tesseract-decoder 0.1.1.dev20250730020326
File	Interpreter	ABI	Platform	Reset
tesseract_decoder-0.1.1.dev20250730020326-py312-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl 3.3 MB Jul 30, 2025	Python 3.12	none	Linux glibc 2.17+ x86-64	Details
tesseract_decoder-0.1.1.dev20250730020326-py312-none-macosx_11_0_arm64.whl 3.0 MB Jul 30, 2025	Python 3.12	none	macOS 11.0+ ARM64	Details
tesseract_decoder-0.1.1.dev20250730020326-py312-none-macosx_10_13_x86_64.whl 2.9 MB Jul 30, 2025	Python 3.12	none	macOS 10.13+ x86-64	Details
tesseract_decoder-0.1.1.dev20250730020326-py311-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl 3.3 MB Jul 30, 2025	Python 3.11	none	Linux glibc 2.17+ x86-64	Details
tesseract_decoder-0.1.1.dev20250730020326-py311-none-macosx_11_0_arm64.whl 3.0 MB Jul 30, 2025	Python 3.11	none	macOS 11.0+ ARM64	Details
tesseract_decoder-0.1.1.dev20250730020326-py311-none-macosx_10_13_x86_64.whl 2.9 MB Jul 30, 2025	Python 3.11	none	macOS 10.13+ x86-64	Details
tesseract_decoder-0.1.1.dev20250730020326-py310-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl 3.3 MB Jul 30, 2025	Python 3.10	none	Linux glibc 2.17+ x86-64	Details
tesseract_decoder-0.1.1.dev20250730020326-py310-none-macosx_11_0_arm64.whl 3.0 MB Jul 30, 2025	Python 3.10	none	macOS 11.0+ ARM64	Details
tesseract_decoder-0.1.1.dev20250730020326-py310-none-macosx_10_13_x86_64.whl 2.9 MB Jul 30, 2025	Python 3.10	none	macOS 10.13+ x86-64	Details

Total release size: 27.6 MB

Release files / tesseract_decoder-0.1.1.dev20250730020326-py312-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL	tesseract_decoder-0.1.1.dev20250730020326-py312-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size	3.3 MB
Tags	Linux glibc 2.17+ x86-64 Python 3.12
SHA-256 checksum How to use checksums	`b50ad220cda0e57e8927744886e602d72a24cb6eb5bb52f6e3735b2ac48ac88f`
BLAKE2b-256 checksum How to use checksums	`e9625802bfa79eead30d391f6d14805b7a40baf56605babb535dcc3135bd2df3`
Upload date	Jul 30, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.23`

Release files / tesseract_decoder-0.1.1.dev20250730020326-py312-none-macosx_11_0_arm64.whl

Download URL	tesseract_decoder-0.1.1.dev20250730020326-py312-none-macosx_11_0_arm64.whl
Size	3.0 MB
Tags	Python 3.12 macOS 11.0+ ARM64
SHA-256 checksum How to use checksums	`f51a28127224d75df964fc24dbc58338448b0a71fe79837f1a79929a2abefdb9`
BLAKE2b-256 checksum How to use checksums	`d126816bc0779490f5974be9d574425700e37d16e4768d96299745f2c66ede6f`
Upload date	Jul 30, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.23`

Release files / tesseract_decoder-0.1.1.dev20250730020326-py312-none-macosx_10_13_x86_64.whl

Download URL	tesseract_decoder-0.1.1.dev20250730020326-py312-none-macosx_10_13_x86_64.whl
Size	2.9 MB
Tags	Python 3.12 macOS 10.13+ x86-64
SHA-256 checksum How to use checksums	`586b9a2e1e0231a7750ee298e5aa6103111dbe1a2e754dbf5029ebd013689df1`
BLAKE2b-256 checksum How to use checksums	`b51434af068c211dd246b04c4cc810b58a26568be24756d0f43127f941ef45ac`
Upload date	Jul 30, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.23`

Release files / tesseract_decoder-0.1.1.dev20250730020326-py311-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL	tesseract_decoder-0.1.1.dev20250730020326-py311-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size	3.3 MB
Tags	Linux glibc 2.17+ x86-64 Python 3.11
SHA-256 checksum How to use checksums	`678aa42b184649f2dc3f54c005b2e80dacfe52364dc35df85ecabaa697632064`
BLAKE2b-256 checksum How to use checksums	`ba46180452a4a7955661a54ed90878d6aa591a1f847c6b748ea17b547f6e3480`
Upload date	Jul 30, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.23`

Release files / tesseract_decoder-0.1.1.dev20250730020326-py311-none-macosx_11_0_arm64.whl

Download URL	tesseract_decoder-0.1.1.dev20250730020326-py311-none-macosx_11_0_arm64.whl
Size	3.0 MB
Tags	Python 3.11 macOS 11.0+ ARM64
SHA-256 checksum How to use checksums	`74ef697a34461eea4fcab03aef3cfe8b91b199fb18750859e86338fb0fe3155a`
BLAKE2b-256 checksum How to use checksums	`f61cfefd02f3ca666a14b813c2fa8d916290c082e9bcb981c61cb73680a3ddfa`
Upload date	Jul 30, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.23`

Release files / tesseract_decoder-0.1.1.dev20250730020326-py311-none-macosx_10_13_x86_64.whl

Download URL	tesseract_decoder-0.1.1.dev20250730020326-py311-none-macosx_10_13_x86_64.whl
Size	2.9 MB
Tags	Python 3.11 macOS 10.13+ x86-64
SHA-256 checksum How to use checksums	`55651967bd880c00d2be2153282df01415fbbf8b6f9acaa249e62aac24bf59d8`
BLAKE2b-256 checksum How to use checksums	`7eaf3523ce71f1a41436cacc13e453fd816bec08d442c6a0591aac6bd32f2f0e`
Upload date	Jul 30, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.23`

Release files / tesseract_decoder-0.1.1.dev20250730020326-py310-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL	tesseract_decoder-0.1.1.dev20250730020326-py310-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size	3.3 MB
Tags	Linux glibc 2.17+ x86-64 Python 3.10
SHA-256 checksum How to use checksums	`0bf898ee30eabfe1ec227d31c7143387b7987aa4717175ae46e2d251655fb3b0`
BLAKE2b-256 checksum How to use checksums	`e51ef81058ac898abddc2f3e56f79360679275eeee01470d839127beacd809cd`
Upload date	Jul 30, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.23`

Release files / tesseract_decoder-0.1.1.dev20250730020326-py310-none-macosx_11_0_arm64.whl

Download URL	tesseract_decoder-0.1.1.dev20250730020326-py310-none-macosx_11_0_arm64.whl
Size	3.0 MB
Tags	Python 3.10 macOS 11.0+ ARM64
SHA-256 checksum How to use checksums	`d39eb6dcbf8920dd81362043ce3a14a31c934b8923bce1f0ef484fbd4de9ce36`
BLAKE2b-256 checksum How to use checksums	`c61085930b5e1cf8b0caa17053d161cb6702e521ed5ed00b70062a2746cd1937`
Upload date	Jul 30, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.23`

Release files / tesseract_decoder-0.1.1.dev20250730020326-py310-none-macosx_10_13_x86_64.whl

Download URL	tesseract_decoder-0.1.1.dev20250730020326-py310-none-macosx_10_13_x86_64.whl
Size	2.9 MB
Tags	Python 3.10 macOS 10.13+ x86-64
SHA-256 checksum How to use checksums	`4039e2f6710d71b44f0a6c562d3d20a7f93aa566f68844ece1573d51bc3f09e7`
BLAKE2b-256 checksum How to use checksums	`a74b9b4370e873859b850907eeddeb1753970fc4dc25ebe419b55e49275e4106`
Upload date	Jul 30, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.9.23`