Merge branch 'main' of https://github.com/quantumlib/tesseract-decoder

Author: noajshu

.github/workflows/prerelease.yml

@@ -47,7 +47,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-22.04, ubuntu-24.04, macos-13, macos-14]
-        python-version: ['3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
     steps:
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
     - name: Set up Python

.github/workflows/stable-release-workflow.yml

@@ -46,7 +46,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-22.04, ubuntu-24.04, macos-13, macos-14]
-        python-version: ['3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12', '3.13']
 
     steps:
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

BUILD

@@ -39,6 +39,7 @@ py_wheel(
     summary="A search-based decoder for quantum error correction (QEC).",
     author="The Tesseract Decoder Authors.",
     homepage="https://github.com/quantumlib/tesseract-decoder",
+    license="Apache 2",
 )
 
 config_setting(

README.md

@@ -17,6 +17,7 @@ A Search-Based Decoder for Quantum Error Correction.
 
 </div>
 
+
 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
@@ -167,6 +168,11 @@ Here are some tips for improving performance:
 
 This repository contains the C++ implementation of the Tesseract quantum error correction decoder, along with a Python wrapper. The Python wrapper/interface exposes the decoding algorithms and helper utilities, allowing Python users to leverage this high-performance decoding algorithm.
 
+For installation:
+```bash
+pip install tesseract-decoder
+```
+
 The following example demonstrates how to create and use the Tesseract decoder using the Python interface.
 
 ```python
@@ -206,8 +212,37 @@ print(f"Predicted errors indices: {predicted_errors}")
 for i in predicted_errors:
     print(f"    {i}: {decoder.errors[i]}")
 ```
+## Good Starting Points for Tesseract Configurations:
+ The [Tesseract paper](https://arxiv.org/pdf/2503.10988) recommends two setup for starting your exploration with tesseract:
 
 
+(1) Long-beam setup:
+```
+tesseract_config = tesseract.TesseractConfig(
+    dem=dem,
+    pqlimit=1_000_000,
+    det_beam=20,
+    beam_climbing=True,
+    num_det_orders=21,
+    det_order=tesseract_decoder.utils.DetOrder.DetIndex,
+    no_revisit_dets=True,
+)
+```
+(2) Short-beam setup:
+
+```
+tesseract_config = tesseract.TesseractConfig(
+    dem=dem,
+    pqlimit=200_000,
+    det_beam=15,
+    beam_climbing=True,
+    num_det_orders=16,
+    det_order=tesseract_decoder.utils.DetOrder.DetIndex,
+    no_revisit_dets=True,
+)
+```
+For `det_order`, you can use two other options of `DetIndex` and `DetCoordinate` as well.
+These values balance decoding speed and accuracy across the benchmarks reported in the paper and can be adjusted for specific use cases.
 ## Help
 
 *   Do you have a feature request or want to report a bug? [Open an issue on

src/common.cc

@@ -127,7 +127,8 @@ stim::DetectorErrorModel common::merge_indistinguishable_errors(
       case stim::DemInstructionType::DEM_ERROR: {
         Error error(instruction);
         if (error.symptom.detectors.size() == 0) {
-          throw std::invalid_argument("Errors that do not flip any detectors are not supported.");
+          // TODO: For errors without detectors, the observables should be included if p>0.5
+          std::cout << "Warning: the circuit has errors that do not flip any detectors \n";
         }
 
         if (errors_by_symptom.find(error.symptom) != errors_by_symptom.end()) {