Metadata-Version: 2.4
Name: localuf
Version: 3.4.4
Summary: A Python package to simulate and visualise Union-Find-related decoders for CSS codes.
Project-URL: Homepage, https://github.com/timchan0/localuf
Project-URL: Documentation, https://timchan0.github.io/localuf/
Project-URL: Repository, https://github.com/timchan0/localuf.git
Project-URL: Issues, https://github.com/timchan0/localuf/issues
Author-email: Tim Chan <timwlc@icloud.com>
License: MIT
License-File: LICENSE
Keywords: css-codes,decoders,quantum-error-correction,union-find
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: ipykernel
Requires-Dist: ipywidgets
Requires-Dist: matplotlib
Requires-Dist: networkx
Requires-Dist: pandas
Requires-Dist: pymatching
Requires-Dist: scipy
Requires-Dist: statsmodels
Requires-Dist: stim
Requires-Dist: typing-extensions; python_version < '3.12'
Provides-Extra: docs
Requires-Dist: sphinx>=7; extra == 'docs'
Description-Content-Type: text/markdown

# localuf (Local Union-Find)

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

A Python package to simulate and visualise
Union-Find-related decoders for the surface and repetition codes.
Used in the papers on [Snowflake](https://arxiv.org/abs/2406.01701)
and [Macar/Actis](https://quantum-journal.org/papers/q-2023-11-14-1183/).

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

## Tutorial
See the [`demo_notebooks/intro.ipynb`](https://github.com/timchan0/localuf/blob/main/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`](https://github.com/timchan0/localuf/blob/main/uml_class_diagrams.md).