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.
localuf is available as a PyPI package
so it can be installed by running pip install localuf.
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.
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
All UML class diagrams can be found in uml_class_diagrams.md.