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.

Download files

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

Source Distribution

qrmfold-0.8.2.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

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

qrmfold-0.8.2-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file qrmfold-0.8.2.tar.gz.

File metadata

  • Download URL: qrmfold-0.8.2.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for qrmfold-0.8.2.tar.gz
Algorithm Hash digest
SHA256 195a3fedbbccf9d75afce19dc3dd8ac81b05abf9e54c38bcf80816eabaefd5b9
MD5 ea5e7b3f1eeb7557e63d6acc95927c2e
BLAKE2b-256 28df7f941cd489ccf26aaa9b72ed36c873b64c7928867b84d9f31a8611848c2b

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmfold-0.8.2.tar.gz:

Publisher: publish-pypi.yml on timchan0/qrmfold

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

File details

Details for the file qrmfold-0.8.2-py3-none-any.whl.

File metadata

  • Download URL: qrmfold-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for qrmfold-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 62950d57d458b99fa8e2876626838205434c9d825926ed40a12a64e562967363
MD5 1bb076e0143c02fdf99bed6f121f8b4e
BLAKE2b-256 772fa56092bec4cdede9676bfdf749cfc1d8c4528958a267fd367f30ac447d80

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmfold-0.8.2-py3-none-any.whl:

Publisher: publish-pypi.yml on timchan0/qrmfold

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

Release history Release notifications | RSS feed

This release

0.8.2 This release

2 files

0.8.1

2 files

0.8.0

2 files

0.7.2

2 files

0.6.3

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page