PECOS (Performance Estimator of Codes On Surfaces) is a package designed to facilitate the evaluation and study of quantum error correcting codes.
Project description
PECOS (Performance Estimator of Codes On Surfaces) is a Python framework for studying, developing, and evaluating quantum error-correction protocols.
- Author: Ciarán Ryan-Anderson
- Language: Python 3.5.2+ (with optional C and C++ extensions)
Contact
For questions or suggestions, please feel free to contact the author:
- Ciarán Ryan-Anderson, ciaran@pecos.io
Getting Started
To get started, check out the documentation in the "docs" folder or find it online at:
https://quantum-pecos.readthedocs.io
Requirements
- Python 3.5.2+
- NumPy 1.15+
- SciPy 1.1+
- Matplotlib 2.2+
- NetworkX 2.1+
Optional Dependencies
- Cython (to compile optional C/C++ extensions)
- pytest 3.0+ (to run tests)
- Sphinx 2.7.6+ (to compile the documentation)
Installation
To install using pip run the command:
pip install quantum-pecos
To install from GitHub go to:
https://github.com/PECOS-packages/PECOS
Then, download/unzip or clone the version of PECOS you would like to use. Next, navigate to the root of the package (where setup.py is located) and run:
pip install .
To install and continue to develop the version of PECOS located in the install folder, run the following instead:
pip install -e .
Uninstall
To uninstall run:
pip uninstall quantum-pecos
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.