Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.43 KB

README.rst

File metadata and controls

65 lines (44 loc) · 2.43 KB

plaquette: an all-encompassing fault-tolerance software package

Documentation Status
Distance-5 rotated planar code

plaquette is a fully featured and easy-to-use library for studying quantum error correction and fault tolerance.

The library features numerous quantum error correction codes, hardware-relevant error models and versatile decoders that can be used together seamlessly, and it is tailored to accommodate both newcomers and experienced users alike!

WARNING: plaquette is undergoing a big update, with new features being already implemented and others in the works. Stay tuned for our v1.0 release! :)

Installation

plaquette is a pure Python package, so it can be easily installed via pip:

pip install plaquette --pre

--pre is necessary while the only available release of plaquette is marked as alpha. We will drop this requirement soon!

Documentation

Live pre-compiled documentation is available here.

Alternatively, the documentation can be built from the master branch by:

make -C docs clean html

and the build files will be available in the docs/_build/html directory.

Need help? Want to contribute?

plaquette is under heavy development, so it might have some rough corners that need polishing. If you encounter something you think (or the docs say) should work but does not, just open an issue or, if you also want to share a solution, a pull request! See our development standard to have an idea of how to match your suggestions to the codebase.

Want to simply share feedback or you're unsure how to do something? Open a new discussion!

Supporters

plaquette is developed and maintained by QC Design. plaquette is also supported by the German Ministry of Education and Research (BMBF) via project PhotonQ.