Metadata-Version: 2.3
Name: mimiqcircuits
Version: 0.16.0
Summary: User API for MIMIQ by QPerfect. Build quantum circuits, schedule remote simulations, and explore simulation results.
License: Apache-2.0
Author: Guido Masella
Author-email: guido.masella@qperfect.io
Requires-Python: >=3.9,<4
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: visualization
Requires-Dist: bitarray (>=2.9,<3)
Requires-Dist: matplotlib (>=3.8,<4) ; extra == "visualization"
Requires-Dist: mimiqlink (>=0.7,<0.8)
Requires-Dist: numpy (>=1.26,<3.0)
Requires-Dist: protobuf (>=5.26,<6)
Requires-Dist: scipy (>=1.13,<2)
Requires-Dist: symengine (>=0.11,<1.0)
Requires-Dist: sympy (>=1.12,<2)
Project-URL: Documentation, https://docs.qperfect.io
Project-URL: Repository, https://github.com/qperfect-io/mimiqcircuits-python
Description-Content-Type: text/markdown

# Python interface to MIMIQ Circuits (`mimiqcircuits`)

*A library to handle quantum circuits for **QPerfect**'s MIMIQ Emulator.*

| **Documentation**                                                               | **Build Status**                                                                                |
|:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | [![][GHA-img]][GHA-url] |

## Installation

```
pip install "mimiqcircuits @ git+https://github.com/qperfect-io/mimiqcircuits-python.git
````

## Documentation

- [**STABLE**][docs-stable-url] &mdash; **documentation of the most recently version.**

## Project Status

The package is tested against, and being developed for, Python 3.8 and above
on Linux, MacOS, and Windows.

*MIMIQ Circuits* is currently in the alpha stage and open to test for early
adopters. We are continuously refining and enhance our tools so we value any
feedback you may have to ensure that MIMIQ Circuits meets and exceeds your
expectations. If you want access to MIMIQ Circuits, we encourage you register
on [our website](https://qperfect.io/index.php/mimiq-circuits).

## Related projects

* [MimiqCircuits.jl](https://github.com/qperfect-io/MimiqCircuits.jl) the Julia version of this library.

## COPYRIGHT

Copyright © 2022-2023 University of Strasbourg. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://qperfect-io.github.io/mimiqcircuits-python/

[GHA-img]: https://github.com/qperfect-io/mimiqcircuits-python/workflows/test/badge.svg
[GHA-url]: https://github.com/qperfect-io/mimiqcircuits-python/actions?query=workflows/test

