Metadata-Version: 2.4
Name: qoqo_qir
Version: 0.3.0
Requires-Dist: qoqo>=1.18,<2.0
Requires-Dist: qoqo-calculator-pyo3>=1.4
Requires-Dist: tomli ; extra == 'docs'
Requires-Dist: numpy ; extra == 'docs'
Requires-Dist: sphinx>=2.1 ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: pygments ; extra == 'docs'
Requires-Dist: recommonmark ; extra == 'docs'
Requires-Dist: myst-parser ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: docs
License-File: LICENSE
Maintainer-email: HQS Quantum Simulations GmbH <info@quantumsimulations.de>
License: Apache-2.0 AND Apache-2.0 with LLVM-exception AND MIT AND Unicode-DFS-2016 AND
	BSD-2-Clause AND BSD-3-CLause
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

# qoqo-qir

[![Documentation Status](https://img.shields.io/badge/docs-read-blue)](https://hqsquantumsimulations.github.io/qoqo_qir/)
[![GitHub Workflow Status](https://github.com/HQSquantumsimulations/qoqo_qir/workflows/ci_tests/badge.svg)](https://github.com/HQSquantumsimulations/qoqo_qir/actions)
[![PyPI](https://img.shields.io/pypi/v/qoqo_qir)](https://pypi.org/project/qoqo_qir/)
[![PyPI - Format](https://img.shields.io/pypi/format/qoqo_qir)](https://pypi.org/project/qoqo_qir/)
![Crates.io](https://img.shields.io/crates/l/qoqo-qir)

QIR interface for the qoqo quantum toolkit by [HQS Quantum Simulations](https://quantumsimulations.de).

qoqo-qir provides the QirBackend class that allows users translate a qoqo circuit into a QIR file.
Not all qoqo operations have a corresponding QIR expression.  
Circuits containing operations without a corresponding expression cannot be translated.

The API documentation is available [here](https://hqsquantumsimulations.github.io/qoqo-qir/generated/qoqo_qir.html#module-qoqo_qir).

If you intend to use the produced QIR expression with the QIR alliance's QIR-runner you should use the measure_all argument.

A source distribution now exists but requires a Rust install with a rust version > 1.47 and a maturin version { >= 0.14, <0.15 } in order to be built.

## General Notes

This software is still in the beta stage. Functions and documentation are not yet complete and breaking changes can occur.

## Contributing

We welcome contributions to the project. If you want to contribute code, please have a look at CONTRIBUTE.md for our code contribution guidelines.

