localuf (Local Union-Find)
A Python package to simulate and visualise Union-Find-related decoders for the surface and repetition codes. Used in the papers on Snowflake and Macar/Actis.
Installation Instructions
localuf is available as a PyPI package
so it can be installed by running pip install localuf.
Tutorial
See the demo_notebooks/intro.ipynb
notebook.
The first section is a demo of the Macar and Actis decoders.
The second section is a demo of the Snowflake decoder.
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. First ensure you are in a Python environment (conda env, venv, etc.) where Sphinx is installed:
- One-liner:
sphinx-build -b html docs docs/_build/html - Or via Makefile:
make -C docs html
Code Structure
All UML class diagrams can be found in uml_class_diagrams.md.
1 maintainer
Metadata
1 maintainer
Release files for localuf 3.4.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| localuf-3.4.4.tar.gz | 630.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| localuf-3.4.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 718.1 kB
Release files / localuf-3.4.4.tar.gz
| Download URL | localuf-3.4.4.tar.gz |
|---|---|
| Size | 630.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
282010ba7587445fda01425dd1155f7ab99b9949bbfb28e4045b1f20999dde6c
|
|
BLAKE2b-256 checksum How to use checksums |
2b75e501a0e01bc92ed337ff51379a2740d293314c0863115345e89bbc6f7d05
|
| 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 12, 2026.
Transparency logRelease files / localuf-3.4.4-py3-none-any.whl
| Download URL | localuf-3.4.4-py3-none-any.whl |
|---|---|
| Size | 87.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
07f70050e46378c277c02d41caa4d1820baa43af9738347b84cf98c5cddfd845
|
|
BLAKE2b-256 checksum How to use checksums |
c169fb0acd59de193e23475427eed837420273f12eb1796669b5a878fd200901
|
| 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 12, 2026.
Transparency log
