Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.qbraid.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Installation

Install the qiskit extra: 
pip install 'qbraid-qir[qiskit]'
Requires Qiskit >= 2.0.

​
Example Usage

Convert a Qiskit QuantumCircuit to QIR: 
from qiskit import QuantumCircuit
from qbraid_qir import dumps
from qbraid_qir.qiskit import qiskit_to_qir

# create a test circuit

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

# convert to QIR

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

# saves to .ll and .bc files in working directory

dumps(module)

print(module)

​
Transpilation

If your circuit contains gates not directly supported by QIR, you can set transpile=True to automatically decompose them into the supported basis gate set before conversion: 
module = qiskit_to_qir(qc, name="my-circuit", transpile=True)

​
Supported Operations

CategoryGates
Single-qubith, x, y, z, s, sdg, t, tdg, id, reset
Rotationsrx, ry, rz
Two-qubitcx, cz, swap
Three-qubitccx
Measurementmeasure
Otherbarrier, delay