Overview - qBraid

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.10 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]'

For Qiskit to QIR conversions, install the qiskit extra:

pip install 'qbraid-qir[qiskit]'

For Squin to QIR conversions, install the squin extra:

pip install 'qbraid-qir[squin]'

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 '.[qiskit,cirq,qasm3,squin]'

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__

Usage examples

Qiskit conversions

from qiskit import QuantumCircuit
from qbraid_qir.qiskit import qiskit_to_qir

qc = QuantumCircuit(2, 2)
qc.h(0)
qc.cx(0, 1)
qc.measure([0, 1], [0, 1])

module = qiskit_to_qir(qc, name="bell")

ir = str(module)

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)

Currently Supported Operations

QIR to Squin conversions

from qbraid_qir.squin import load
from pyqir import BasicQisBuilder, SimpleModule

mod = SimpleModule("bell", num_qubits=2, num_results=2)
qis = BasicQisBuilder(mod.builder)

qis.h(mod.qubits[0])
qis.cnot(mod.qubits[0], mod.qubits[1])

squin_kernel = load(mod._module)

squin_kernel.print()

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 qBraid-QIR join our discord community
For questions that are more suited for a forum, post to Quantum Computing Stack Exchange with the qbraid tag.

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{Gupta_qBraid-QIR_Python_package_2026,
author = {Gupta, Harshit and Hill, Ryan James},
license = {Apache-2.0},
month = may,
title = {{qBraid-QIR: Python package for QIR conversions, integrations, and utilities.}},
url = {https://github.com/qBraid/qbraid-qir},
version = {0.6.0},
year = {2026}
}

Acknowledgements

This project was conceived in cooperation with the Quantum Open Source Foundation (QOSF).

License

Apache-2.0 License

​Motivation

​Installation

​Optional dependencies

​Install from source

​Check version

​Usage examples

​Qiskit conversions

​Cirq conversions

​OpenQASM 3 conversions

​QIR to Squin conversions

​Architecture diagram

​Contributing

​Citation

​Acknowledgements

​License