Skip to main content

A Python package to construct addressable gates for self-dual quantum Reed-Muller codes as a sequence of transversal and fold-transversal gates.

Project description

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}, 
}

Release (maintainers)

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

Project details


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.0.tar.gz (20.6 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.0-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qrmfold-0.8.0.tar.gz
  • Upload date:
  • Size: 20.6 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.0.tar.gz
Algorithm Hash digest
SHA256 b93bf32275d6cd8f8214270896f69d1b4e5e1cd85ab55de279a793fd363eb987
MD5 e2decd7f80cc778f89eb0d4d725a24ed
BLAKE2b-256 a872c1cd5c58c050cabe0e3162766a500399aa010aa145e9bc59264756054241

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmfold-0.8.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: qrmfold-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 15.2 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c07eacaab888b8f0f1b97232383ddfe337a9f9dc6cf41a5d0261934f8ee51f75
MD5 3783e01c6eea7db27357a3c492f318d3
BLAKE2b-256 ee5da4e329ea021e7dfb918b92c85685a5f7f16d1780562837564dc35d822d8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmfold-0.8.0-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.

Supported by

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