Metadata-Version: 2.1
Name: qecsim
Version: 1.0b7
Summary: Quantum error correction simulator
Home-page: https://bitbucket.org/qecsim/qecsim/
Author: David K. Tuckett
Author-email: qecsim@gmail.com
License: BSD 3-Clause License
Project-URL: Source Code, https://bitbucket.org/qecsim/qecsim/
Project-URL: Documentation, https://davidtuckett.com/qit/qecsim/
Project-URL: Issue tracker, https://bitbucket.org/qecsim/qecsim/issues
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
Requires-Dist: click (>=7)
Requires-Dist: numpy (>=1.17)
Requires-Dist: scipy (>=1.3)
Requires-Dist: networkx (>=2.1)
Requires-Dist: mpmath (>=1)
Provides-Extra: dev
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'

qecsim
======

**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.0b7
    $ 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.0b7'
    >>> 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://bitbucket.org/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://davidtuckett.com/qit/qecsim/

|

Links
-----

* Source code: https://bitbucket.org/qecsim/qecsim/
* Documentation: https://davidtuckett.com/qit/qecsim/
* Issue tracker: https://bitbucket.org/qecsim/qecsim/issues
* Releases: https://pypi.org/project/qecsim/
* Contact: qecsim@gmail.com

----

Copyright 2016, David K. Tuckett.


