Skip to main content

No project description provided

Project description

build codecov PyPI version Unitary Fund

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/
    | benchmarks
        |- maxcut
        |- random_circuits
        |- randomized_benchmarking
        |- utils
    | mitiq_pyquil
        |- conversions
    	|- pyquil_utils
        |- quil
    | mitiq_qiskit
    	|- conversions
    	|- qiskit_utils
    | zne
        |- zne
        |- inference
        |- scaling

Installation

To install locally use:

pip install -e .

To install the requirements for development use:

pip install -r requirements.txt

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 the tests using make test and build the docs using make docs. For more information, see the contributor's guide (linked below).

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

An up-to-date list of authors can be found here

License

GNU GPL v.3.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mitiq-0.1a2.tar.gz (44.6 kB view hashes)

Uploaded Source

Built Distribution

mitiq-0.1a2-py3-none-any.whl (53.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page