Skip to content

Update example in readme #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trmue merged 1 commit into from
Sep 29, 2025
+5 −2
Merged

Update example in readme #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,17 @@ Giving:
The Relay-BP package includes optional integration with [`stim`](https://github.com/quantumlib/Stim) and [`sinter`](https://github.com/quantumlib/Stim/tree/main/glue/sample)
for constructing and running decoding experiments. Install with `pip install ".[stim]"`.

We include reference circuits for a variety of codes in [`testdata/`](./src/relay_bp/stim/testdata/) along with utility method to load these.
We include reference circuits for a variety of codes in [`testdata/`](tests/testdata/) along with utility methods to load these.
Below is an example of decoding the gross code with Stim + Sinter.

```python
import sinter
import multiprocessing
from relay_bp.stim import sinter_decoders
from relay_bp.stim.testdata import get_test_circuit, filter_detectors_by_basis
import sys
from pathlib import Path
sys.path.append(str(Path("tests").resolve()))
from testdata import filter_detectors_by_basis, get_test_circuit

num_workers = multiprocessing.cpu_count()

Expand Down
Loading