Skip to main content

qrmfold

Documentation

qrmfold (Quantum Reed-Muller Fold) is the Python package accompanying the paper Construction of the full logical Clifford group for high-rate quantum Reed-Muller codes using only transversal and fold-transversal gates.

Installation Instructions

qrmfold is available as a PyPI package so it can be installed by running pip install qrmfold.

Tutorial

See the getting_started.ipynb notebook. For more detail on individual functions/methods, see below.

Documentation

If you just want to read the documentation, click the blue Documentation badge at the top of this README.

Optionally, you can build the HTML docs locally:

  • Install docs dependencies: pip install -e ".[docs]"
  • Build: cd docs && make html
  • Open: docs/build/html/index.html

How to cite qrmfold

Please cite the accompanying paper:

@misc{tansuwannont2026constructionlogicalcliffordgroup,
      title={Construction of the full logical Clifford group for high-rate quantum Reed-Muller codes using only transversal and fold-transversal gates}, 
      author={Theerapat Tansuwannont and Tim Chan and Ryuji Takagi},
      year={2026},
      eprint={2602.09788},
      archivePrefix={arXiv},
      primaryClass={quant-ph},
      url={https://arxiv.org/abs/2602.09788}, 
}

Tests

This package uses the pytest framework. The tests are divided into unit tests and integration tests. The integration tests verify that:

  1. the fold-transversal gates preserve the stabilizer group (Theorems 3 and 4),
  2. the fold-transversal gates induce the logical action predicted by Theorems 5 and 6,
  3. the addressable gates built from Corollary 1 and Theorems 7 and 8 induce the desired logical action.

Note there is one test, test_quantum_reed_muller_integration.TestAddressableLogicalAction.test_2_qubit_gate for the parameter $m =6$, that takes considerably longer than the others i.e. about 300 s on a laptop.

Release (maintainers)

This repo includes a GitHub Actions workflow that publishes to PyPI when a version tag like v0.7.0 is pushed.

Metadata

Release files for qrmfold 0.8.2

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

Source distribution (sdist)

Source distribution for qrmfold 0.8.2
File Size Uploaded
qrmfold-0.8.2.tar.gz 22.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for qrmfold 0.8.2
File Interpreter ABI Platform
qrmfold-0.8.2-py3-none-any.whl Python 3 none any Details

Total release size: 37.6 kB

Release files / qrmfold-0.8.2.tar.gz

Download URL qrmfold-0.8.2.tar.gz
Size 22.0 kB
Tags Source
SHA-256 checksum
How to use checksums
195a3fedbbccf9d75afce19dc3dd8ac81b05abf9e54c38bcf80816eabaefd5b9
BLAKE2b-256 checksum
How to use checksums
28df7f941cd489ccf26aaa9b72ed36c873b64c7928867b84d9f31a8611848c2b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 11, 2026.

Transparency log

Release files / qrmfold-0.8.2-py3-none-any.whl

Download URL qrmfold-0.8.2-py3-none-any.whl
Size 15.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
62950d57d458b99fa8e2876626838205434c9d825926ed40a12a64e562967363
BLAKE2b-256 checksum
How to use checksums
772fa56092bec4cdede9676bfdf749cfc1d8c4528958a267fd367f30ac447d80
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 11, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.8.2 This release

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.2

2 release files

0.6.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page