tqecd

The tqecd package is a spin-off from the tqec package that allows the automatic search of detectors in structured quantum error correction circuits.

This package was initially part of tqec and has been outsourced to make it accessible to anyone wanting to use it outside of the tqec library.

Documentation

Documentation is available at https://tqec.github.io/tqecd/index.html.

Installation

Currently, tqecd needs to be installed from source using

python -m pip install git+https://github.com/tqec/tqecd.git

Basic usage

import stim

from tqecd import annotate_detectors_automatically

# Example circuit that contains a detector
XXXX = stim.Circuit("""\
QUBIT_COORDS(1, 1) 0
QUBIT_COORDS(0, 0) 1
QUBIT_COORDS(2, 0) 2
QUBIT_COORDS(0, 2) 3
QUBIT_COORDS(2, 2) 4
RX 0 1 2 3 4
TICK
CX 0 1
TICK
CX 0 2
TICK
CX 0 3
TICK
CX 0 4
TICK
MX 0
""")
assert XXXX.num_detectors == 0

annotated_circuit = annotate_detectors_automatically(XXXX)
print(annotated_circuit)

should output the following quantum circuit:

QUBIT_COORDS(1, 1) 0
QUBIT_COORDS(0, 0) 1
QUBIT_COORDS(2, 0) 2
QUBIT_COORDS(0, 2) 3
QUBIT_COORDS(2, 2) 4
RX 0 1 2 3 4
TICK
CX 0 1
TICK
CX 0 2
TICK
CX 0 3
TICK
CX 0 4
TICK
MX 0
DETECTOR(1, 1, 0) rec[-1]

Contributing

Pull requests and issues are more than welcomed!

See the contributing page for specific contributing instructions.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tqecd-0.2.1.tar.gz (45.9 kB view details)

Uploaded Jul 5, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

tqecd-0.2.1-py3-none-any.whl (49.2 kB view details)

Uploaded Jul 5, 2026 Python 3

File details

Details for the file tqecd-0.2.1.tar.gz.

File metadata

Download URL: tqecd-0.2.1.tar.gz
Upload date: Jul 5, 2026
Size: 45.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tqecd-0.2.1.tar.gz
Algorithm	Hash digest
SHA256	`2ece998ad0b1955ef336a4fac3a3e58c4a1afda926e134d82d0a5cf4e96fc04e`
MD5	`ce67df64a7425af02d5c7cac649eba1b`
BLAKE2b-256	`a396feda08dbf09f8b20b7223e25dbf4fd51714439f9f7254a21f5faeeb4eb92`

See more details on using hashes here.

Provenance

The following attestation bundles were made for tqecd-0.2.1.tar.gz:

Publisher: publish.yml on tqec/tqecd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: tqecd-0.2.1.tar.gz
- Subject digest: 2ece998ad0b1955ef336a4fac3a3e58c4a1afda926e134d82d0a5cf4e96fc04e
- Sigstore transparency entry: 2081552890
- Sigstore integration time: Jul 5, 2026
Source repository:
- Permalink: tqec/tqecd@5cfcbbe3fa76d90ed1db3b27ae9ba5d662b35fea
- Branch / Tag: refs/tags/v0.2.1
- Owner: https://github.com/tqec
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@5cfcbbe3fa76d90ed1db3b27ae9ba5d662b35fea
- Trigger Event: push