✨ Analog information decoding

src/mqt/qecc/analog-information-decoding/.gitignore

@@ -0,0 +1,134 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+*.mtx
+*.json
+ldpc2/*
+generated_codes/*
+results/*

src/mqt/qecc/analog-information-decoding/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Lucas Berent, Timo Hillmann
+
+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.

src/mqt/qecc/analog-information-decoding/README.md

@@ -0,0 +1,52 @@
+# Analog Information Decoding
+
+This submodule provides means to conduct decoding simulations for quantum CSS codes with
+analog syndrome information as proposed in the corresponding paper [1].
+Proper integration and setup is a work in progress.
+The main functionality is provided in the `simulators` module, which contains the main classes
+that can be used to conduct several types of simulations:
+
+* `ATD_Simulator`: Analog Tanner graph decoding,
+* `Single-Shot Simulator`: Analog Single-Shot decoding with meta checks.
+* `QSS_Simulator`: Quasi-Single-Shot decoding, and
+
+Moreover, `memory_experiment` contains methods for analog overlapping window decoding, in
+particular the `decode_multiround` method.
+
+## Results
+
+The `results` directory contains the results used in the paper [1].
+
+## Codes
+
+The `codes` directory contains the parity-check matrices of the codes used in the paper [1].
+Three dimensional toric codes can either be constructed with the hypergraph product construction
+or with a library, e.g., panqec [3].
+### Code construction
+
+The `code_construction` directory contains the code used to construct higher-dimensional hypergraph
+product codes and used the `compute_distances.sh` script to automatically compute bounds on the
+distances of the constructed codes using the GAP library QDistRnd.
+
+## Utils
+
+### Plotting
+
+The `plotting` directory contains the code used to plot the results in the paper [1].
+
+### Data Utils
+
+We have implemented several utility functions as part of this package that might be of independent
+interest for decoding simulations and data analysis. These are provided in the `data_utils` module
+in the `utils` package.
+
+## Dependencides
+
+The used BP+OSD implementation, as well as our implementation of the SSMSA decoder are provided
+in the LDPC2 package a preliminary beta version of which is available on Github [2].
+
+## References
+
+- [1]: L. Berent, T. Hillmann et al.: https://arxiv.org/TODO
+- [2]: J. Roffe et al. https://github.com/quantumgizmos/ldpc/tree/ldpc_v2
+- [3]: E. Huang et al. https://github.com/panqec/panqec

src/mqt/qecc/analog-information-decoding/__init__.py

@@ -0,0 +1,11 @@
+from simulators.analog_tannergraph_decoding import AnalogTannergraphDecoder, SoftInfoDecoder, ATD_Simulator
+from simulators.quasi_single_shot_v2 import QSS_SimulatorV2
+from simulators.simulation import Single_Shot_Simulator
+
+__all__ = [
+    "AnalogTannergraphDecoder",
+    "SoftInfoDecoder",
+    "ATD_Simulator",
+    "QSS_SimulatorV2",
+    "Single_Shot_Simulator",
+]