Mitiq

A Python toolkit for implementing error mitigation on quantum computers.

Features

Mitiq performs error mitigation protocols on quantum circuits using zero-noise extrapolation.

Contents

mitiq/mitiq/
    | about
    | benchmarks    (package)
        |- maxcut
        |- tests    (package)
            |- test_maxcut
            |- test_random_circ
        |- random_circ
        |- utils
    | factories
    | folding
    | matrices
    | mitiq_pyquil   (package)
    	|- pyquil_utils
    	|- tests   (package)
       		|- test_zne
    | mitiq_qiskit   (package)
    	|- conversions
    	|- qiskit_utils
       	|- tests   (package)
       		|- test_conversions
       		|- test_zne
    | tests    (package)
    	|- test_factories
    	|- test_folding
    	|- test_matrices
    	|- test_utils
        |- test_zne
    | utils
    | zne

Installation

To install locally use:

pip install -e .

To install for development use:

pip install -e .[development]

Note that this will install our testing environment that depends on qiskit and pyquil.

Use

A Getting Started tutorial can be found in the Documentation.

Documentation

Mitiq documentation is found under mitiq/docs. A pdf with the documentation updated to the latest release can be found here.

Development and Testing

Ensure that you have installed the development environment. Then you can run tests and build the docs with ./test_build.sh.

Contributing

You can find information on contributing to mitiq code in the contributing guidelines.

To contribute to the documentation, read the instructions in the mitiq/docs folder.

Authors

Ryan LaRose, Andrea Mari, Nathan Shammah, and Will Zeng. An up-to-date list of authors can be found here

License

GNU GPL v.3.0.