This release is a pre-release and may not be stable for production use.
qBraid-SDK extension providing support for QIR conversions.
Motivation
This project aims to make QIR representations accessible via the qBraid-SDK transpiler, and by doing so, open the door to language-specific conversions from any and all high-level quantum languages supported by qbraid. See QIR Alliance: why do we need it?.
Installation
qBraid-QIR requires Python 3.8 or greater, and can be installed with pip as follows:
pip install qbraid-qir
Optional dependencies
qBraid-QIR offers integrations that require extra (optional) dependencies, which can be installed as follows:
For Cirq to QIR conversions, install the cirq extra:
pip install 'qbraid-qir[cirq]'
For OpenQASM 3 to QIR conversions, install the qasm3 extra:
pip install 'qbraid-qir[qasm3]'
Install from source
You can also install from source by cloning this repository and running a pip install command in the root directory of the repository:
git clone https://github.com/qBraid/qbraid-qir.git
cd qbraid-qir
pip install .
To include optional dependencies when installing from source, use the same "extras_require" format, e.g.
pip install '.[cirq,qasm3]'
Check version
You can view the version of qbraid-qir you have installed within a Python shell as follows:
In [1]: import qbraid_qir
In [2]: qbraid_qir.__version__
Resources
Usage examples
Cirq conversions
import cirq
from qbraid_qir.cirq import cirq_to_qir
q0, q1 = cirq.LineQubit.range(2)
circuit = cirq.Circuit(
cirq.H(q0),
cirq.CNOT(q0, q1),
cirq.measure(q0, q1)
)
module = cirq_to_qir(circuit, name="my-circuit")
ir = str(module)
OpenQASM 3 conversions
from qbraid_qir.qasm3 import qasm3_to_qir
program = """
OPENQASM 3;
include "stdgates.inc";
qubit[2] q;
bit[2] c;
h q[0];
cx q[0], q[1];
measure q[0] -> c[0];
measure q[1] -> c[1];
"""
module = qasm3_to_qir(program, name="my-program")
ir = str(module)
Add QIR node to qBraid conversion graph
from qbraid_qir.cirq import cirq_to_qir
from qbraid.transpiler import Conversion, ConversionGraph
graph = ConversionGraph()
conversion = Conversion("cirq", "qir", cirq_to_qir)
graph.add_conversion(conversion)
graph.plot()
Architecture diagram
qBraid-SDK transpiler hub-and-spokes architecture with qbraid-qir integration (left) mapped to language specific conversion step in QIR abstraction layers (right).
Contributing
- Interested in contributing code, or making a PR? See CONTRIBUTING.md
- For feature requests and bug reports: Submit an issue
- For discussions, and specific questions about the qBraid-SDK, qBraid-QIR, or other topics, join our discord community
- For questions that are more suited for a forum, post to
Quantum Computing Stack Exchange
with the
qbraidtag. - By participating, you are expected to uphold our code of conduct.
Citation
If you use qBraid-QIR in your research, we kindly request that you cite it appropriately. The BibTeX entry below is aligned with the latest stable release. For the most up-to-date citation details, please refer to CITATION.cff.
@software{Kushnir_qBraid-QIR_Python_package_2024,
author = {Kushnir, Samuel and Gupta, Harshit and Jain, Rohan and Parakh, Priyansh and Hill, Ryan James},
license = {GPL-3.0},
month = mar,
title = {{qBraid-QIR: Python package for QIR conversions, integrations, and utilities.}},
url = {https://github.com/qBraid/qbraid-qir},
version = {0.2.0},
year = {2024}
}
Acknowledgements
This project was conceived in cooperation with the Quantum Open Source Foundation (QOSF).
License
Metadata
Release files for qbraid-qir 0.2.0.dev20240329133451
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| qbraid-qir-0.2.0.dev20240329133451.tar.gz | 325.5 kB | Without provenance | Details for qbraid-qir-0.2.0.dev20240329133451.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| qbraid_qir-0.2.0.dev20240329133451-py3-none-any.whl | Python 3 | none | any | Details for qbraid_qir-0.2.0.dev20240329133451-py3-none-any.whl |
Total release size: 389.7 kB
Release files / qbraid-qir-0.2.0.dev20240329133451.tar.gz
| Download URL | qbraid-qir-0.2.0.dev20240329133451.tar.gz |
|---|---|
| Size | 325.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
86f7b28a900c812645b15f335809730831e08db5c37c65133d550b57f9971371
|
|
BLAKE2b-256 checksum How to use checksums |
c801f839faa722e242d5228f54c3a82c8f1e30a59185f26505eaac86e67f7399
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
Release files / qbraid_qir-0.2.0.dev20240329133451-py3-none-any.whl
| Download URL | qbraid_qir-0.2.0.dev20240329133451-py3-none-any.whl |
|---|---|
| Size | 64.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
74790d635304c14e7300626f3234ebfb7f8b9aa3873c9590703aac000db81999
|
|
BLAKE2b-256 checksum How to use checksums |
076b8ae0867c20a5e23faf5ea8c49406c2739e9cfaa4b423fb09566d193e73cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
Security for qbraid-qir 0.2.0.dev20240329133451
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.