https://github.com/qir-alliance/pyqir

PyQIR is a set of APIs for generating, parsing, and evaluating Quantum Intermediate Representation (QIR).
https://github.com/qir-alliance/pyqir

llvm qir quantum-computing

Last synced: 3 days ago
JSON representation

PyQIR is a set of APIs for generating, parsing, and evaluating Quantum Intermediate Representation (QIR).

• Host: GitHub
• URL: https://github.com/qir-alliance/pyqir
• Owner: qir-alliance
• License: mit
• Created: 2021-11-16T19:18:20.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-23T18:38:09.000Z (8 days ago)
• Last Synced: 2025-01-23T19:28:40.392Z (8 days ago)
• Topics: llvm, qir, quantum-computing
• Language: Rust
• Homepage: https://qir-alliance.github.io/pyqir
• Size: 2.12 MB
• Stars: 61
• Watchers: 5
• Forks: 25
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# PyQIR

PyQIR is a set of APIs for generating, parsing, and evaluating [Quantum Intermediate Representation (QIR)](https://github.com/qir-alliance/qir-spec).

This repository contains:

- [**pyqir**](pyqir) ([examples](examples))

  This package provides a Python API for parsing and generating QIR.

  It is intended to easily integrate the QIR toolchain into existing Python-based frontends.

  For more advanced scenarios, we recommend taking a look at the LLVM-based infrastructure provided by [QAT](https://qir-alliance.github.io/qat/).

  It also provides an easy way to run generated QIR. It contains the necessary [just-in-time compilation](https://en.wikipedia.org/wiki/Just-in-time_compilation) infrastructure as well an extensibility mechanism to define what actions to perform when a gate is applied in Python.

- [**qirlib**](qirlib)

  This is a Rust library wrapping [LLVM](https://llvm.org/) for working with QIR that is used by PyQIR.

## Documentation

- [Getting Started](https://www.qir-alliance.org/pyqir/)

- [Building from Source](https://www.qir-alliance.org/pyqir/building.html)

## Feedback

If you have feedback about the content in this repository, please let us know by

filing a [new issue](https://github.com/qir-alliance/pyqir/issues/new)!

## Contributing

There are many ways in which you can contribute to PyQIR, whether by

contributing a feature or by engaging in discussions; we value contributions in

all shapes and sizes! We refer to [this document](CONTRIBUTING.md) for

guidelines and ideas for how you can get involved.

Contributing a pull request to this repo requires to agree to a [Contributor

License Agreement

(CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) declaring

that you have the right to, and actually do, grant us the rights to use your

contribution. A CLA-bot will automatically determine whether you need to provide

a CLA and decorate the PR appropriately. Simply follow the

instructions provided by the bot. You will only need to do this once.

## Code of Conduct

This project has adopted the community covenant [Code of

Conduct](https://github.com/qir-alliance/.github/blob/main/Code_of_Conduct.md#contributor-covenant-code-of-conduct).

Please contact [[email protected]](mailto:[email protected]) for Code of

Conduct issues or inquiries.