Metadata-Version: 2.1
Name: mitiq
Version: 0.1a2
Summary: UNKNOWN
Home-page: https://unitary.fund
Author: Unitary Fund
License: GPL v3.0
Description: [![build](https://github.com/unitaryfund/mitiq/workflows/build/badge.svg)](https://github.com/unitaryfund/mitiq/actions)
        [![codecov](https://codecov.io/gh/unitaryfund/mitiq/branch/master/graph/badge.svg)](https://codecov.io/gh/unitaryfund/mitiq)
        [![PyPI version](https://badge.fury.io/py/mitiq.svg)](https://badge.fury.io/py/mitiq)
        [![Unitary Fund](https://img.shields.io/badge/Supported%20By-UNITARY%20FUND-brightgreen.svg?style=for-the-badge)](http://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:
        
        ```bash
        pip install -e .
        ```
        
        To install the requirements for development use:
        
        ```bash
        pip install -r requirements.txt
        ```
        
        Note that this will install our testing environment that depends
        on `qiskit` and `pyquil`.
        
        ## Use
        A [Getting Started](https://mitiq.readthedocs.io/en/latest/guide/guide_02-getting-started.html)
        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](docs/pdf/Mitiq-latest-release.pdf).
        
        ## 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](CONTRIBUTING.md).
        
        To contribute to the documentation, read the
        [instructions](docs/README-docs.md) in the `mitiq/docs` folder.
        
        
        ## Authors
        An up-to-date list of authors can be found
        [here](https://github.com/unitaryfund/mitiq/graphs/contributors)
        
        ## License
        [GNU GPL v.3.0.](LICENSE)
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
Provides-Extra: development
Provides-Extra: test
