``plaquette``: an all-encompassing fault-tolerance software package
===================================================================
.. image:: https://readthedocs.org/projects/plaquette-qec/badge/?version=stable
:target: https://docs.plaquette.design/en/stable/?badge=stable
:alt: Documentation Status
.. figure:: docs/index_code.png
:align: right
:alt: 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!
Installation
------------
``plaquette`` is a pure Python package, so it can be easily installed via
``pip``::
pip install plaquette
Documentation
-------------
Live pre-compiled documentation is available `here <https://docs.plaquette.design/>`_.
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 <https://github.com/qc-design/plaquette/issues/new>`_
or, if you also want to share a solution, a
`pull request <https://github.com/qc-design/plaquette/compare>`_! See
our `development standard <https://docs.plaquette.design/en/latest/dev/index.html>`_ 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 <https://github.com/qc-design/plaquette/discussions/new/choose>`_!
Supporters
----------
``plaquette`` is developed and maintained by `QC Design <https://www.qc.design/>`_.
``plaquette`` is also supported by the German Ministry of Education and Research
(BMBF) via project `PhotonQ <https://www.photonq.de/>`_.
Raw data
{
"_id": null,
"home_page": "",
"name": "plaquette",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "Quantum error correction,qec,quantum computing,fault tolerance",
"author": "",
"author_email": "QC Design GmbH <software@qc.design>",
"download_url": "",
"platform": null,
"description": "``plaquette``: an all-encompassing fault-tolerance software package\n===================================================================\n\n.. image:: https://readthedocs.org/projects/plaquette-qec/badge/?version=stable\n :target: https://docs.plaquette.design/en/stable/?badge=stable\n :alt: Documentation Status\n\n.. figure:: docs/index_code.png\n :align: right\n :alt: Distance-5 rotated planar code\n\n``plaquette`` is a fully featured and easy-to-use library for studying quantum\nerror correction and fault tolerance.\n\nThe library features numerous quantum error correction codes, hardware-relevant\nerror models and versatile decoders that can be used together seamlessly,\nand it is tailored to accommodate both newcomers and experienced users alike!\n\nInstallation\n------------\n\n``plaquette`` is a pure Python package, so it can be easily installed via\n``pip``::\n\n pip install plaquette\n\nDocumentation\n-------------\n\nLive pre-compiled documentation is available `here <https://docs.plaquette.design/>`_.\n\nAlternatively, the documentation can be built from the ``master`` branch by::\n\n make -C docs clean html\n\nand the build files will be available in the ``docs/_build/html`` directory.\n\nNeed help? Want to contribute?\n------------------------------\n\n``plaquette`` is under heavy development, so it might have some rough corners that need\npolishing. If you encounter something you think (or the docs say) should work but does\nnot, just open an `issue <https://github.com/qc-design/plaquette/issues/new>`_\nor, if you also want to share a solution, a\n`pull request <https://github.com/qc-design/plaquette/compare>`_! See\nour `development standard <https://docs.plaquette.design/en/latest/dev/index.html>`_ to\nhave an idea of how to match your suggestions to the codebase.\n\nWant to simply share feedback or you're unsure how to do something? Open a new\n`discussion <https://github.com/qc-design/plaquette/discussions/new/choose>`_!\n\n\nSupporters\n----------\n\n``plaquette`` is developed and maintained by `QC Design <https://www.qc.design/>`_.\n``plaquette`` is also supported by the German Ministry of Education and Research\n(BMBF) via project `PhotonQ <https://www.photonq.de/>`_.\n",
"bugtrack_url": null,
"license": "",
"summary": "An all-encompassing quantum error-correction software package",
"version": "0.1",
"project_urls": {
"Bug Tracker": "https://github.com/qc-design/plaquette/issues",
"Homepage": "https://docs.plaquette.design"
},
"split_keywords": [
"quantum error correction",
"qec",
"quantum computing",
"fault tolerance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a22f8dbc4e49dc6ae5f64210872d91f8fd21ec5a3e43a52191f6483beba1f4ea",
"md5": "de31415723b88dc904d453322e0fe2cc",
"sha256": "84b7b5bf0a004a6dd931b0f169e3837d2f271aa4aa0973c0482ab669e63af8d3"
},
"downloads": -1,
"filename": "plaquette-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de31415723b88dc904d453322e0fe2cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 103737,
"upload_time": "2023-12-08T17:24:07",
"upload_time_iso_8601": "2023-12-08T17:24:07.520705Z",
"url": "https://files.pythonhosted.org/packages/a2/2f/8dbc4e49dc6ae5f64210872d91f8fd21ec5a3e43a52191f6483beba1f4ea/plaquette-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 17:24:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qc-design",
"github_project": "plaquette",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "plaquette"
}
JSON
