Metadata-Version: 2.4
Name: qrmfold
Version: 0.8.2
Summary: A Python package to construct addressable gates for self-dual quantum Reed-Muller codes as a sequence of transversal and fold-transversal gates.
Author-email: Tim Chan <timwlc@icloud.com>
License: MIT License
        
        Copyright (c) 2026 Tim Chan
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Requires-Dist: numpy
Requires-Dist: stim
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: ipykernel; extra == 'dev'
Requires-Dist: ipywidgets; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx>=7; extra == 'docs'
Description-Content-Type: text/markdown

# qrmfold

[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://timchan0.github.io/qrmfold/)

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](https://arxiv.org/abs/2602.09788).

## Installation Instructions
qrmfold is available as a [PyPI package](https://pypi.org/project/qrmfold/)
so it can be installed by running `pip install qrmfold`.

## Tutorial
See the
[`getting_started.ipynb`](https://github.com/timchan0/qrmfold/blob/main/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:
```latex
@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.