https://github.com/qecsim/qecsim
qecsim is a Python 3 package for simulating quantum error correction using stabilizer codes.
https://github.com/qecsim/qecsim
python qec quantum-error-correction simulation
Last synced: 2 months ago
JSON representation
qecsim is a Python 3 package for simulating quantum error correction using stabilizer codes.
- Host: GitHub
- URL: https://github.com/qecsim/qecsim
- Owner: qecsim
- License: bsd-3-clause
- Created: 2021-02-07T23:21:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-05T06:44:55.000Z (almost 4 years ago)
- Last Synced: 2025-03-01T06:18:33.692Z (3 months ago)
- Topics: python, qec, quantum-error-correction, simulation
- Language: Python
- Homepage:
- Size: 1 MB
- Stars: 78
- Watchers: 4
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
qecsim
======
.. image:: https://img.shields.io/badge/docs-stable-blue.svg
:target: https://qecsim.github.io/
:alt: Documentation
.. image:: https://github.com/qecsim/qecsim/workflows/CI/badge.svg?branch=master
:target: https://github.com/qecsim/qecsim/actions?workflow=CI
:alt: CI Status
.. image:: https://codecov.io/gh/qecsim/qecsim/branch/master/graph/badge.svg?token=BH80LCIYBZ
:target: https://codecov.io/gh/qecsim/qecsim
:alt: Coverage
.. image:: https://img.shields.io/pypi/v/qecsim
:target: https://pypi.org/project/qecsim/
:alt: PyPI
**qecsim** is a Python 3 package for simulating quantum error correction using
stabilizer codes.
It provides access to all features via a command-line interface. It can also be
used as a library via the fully-documented API. It includes many common codes,
error models and decoders, and can be extended with additional components.
Installation
------------
Install and upgrade using `pip`_:
.. code-block:: text
$ pip install -U qecsim
.. _pip: https://pip.pypa.io/en/stable/quickstart/
Usage
-----
CLI
~~~
.. code-block:: text
$ qecsim --version
qecsim, version 1.0b9
$ qecsim --help # console script
...
$ python -O -m qecsim --help # module script with Python options e.g. -O for optimize
...
API
~~~
.. code-block:: text
>>> import qecsim
>>> qecsim.__version__
'1.0b9'
>>> from qecsim import app
>>> help(app)
...
Extension
~~~~~~~~~
qecsim can be extended with additional codes, error models and decoders that
integrate into the command-line interface.
See https://github.com/qecsim/qecsimext for a basic example.
License / Citing
----------------
qecsim is released under the BSD 3-Clause license. If you use qecsim in your
research, please see the `qecsim documentation`_ for citing details.
.. _qecsim documentation: https://qecsim.github.io/
Links
-----
* Source code: https://github.com/qecsim/qecsim
* Documentation: https://qecsim.github.io/
* Issue tracker: https://github.com/qecsim/qecsim/issues
* Releases: https://pypi.org/project/qecsim/
* Contact: [email protected]
----
Copyright 2016 - 2021, David K. Tuckett.