.. raw:: html
qBraid
| QIR
qBraid-SDK extension providing support for QIR conversions.
|
:Release: |release|
Overview
---------
Python package for generating `QIR `_ (Quantum Intermediate Representation)
programs from various high-level quantum programming languages. This project acts as an extension to the qBraid-SDK `transpiler `_,
opening the door to language-specific conversions from any of the 10+ quantum program types `supported `_
by ``qbraid``.
> "*Interoperability* opens doors to cross-fields problem-solving." \- QIR Alliance: `Why do we need it? `_.
Installation
-------------
qBraid-QIR requires Python 3.10 or greater. The base package can be installed with pip as follows:
.. code-block:: bash
pip install qbraid-qir
To enable specific conversions such as OpenQASM 3 to QIR or Cirq to QIR, you can install one or both extras:
.. code-block:: bash
pip install 'qbraid-qir[qasm3,cirq]'
Resources
----------
- `User Guide `_
- `Example Notebooks `_
- `API Reference `_
- `Source Code `_
.. toctree::
:maxdepth: 1
:caption: SDK API Reference
:hidden:
qbraid
qbraid.programs
qbraid.interface
qbraid.transpiler
qbraid.passes
qbraid.runtime
qbraid.visualization
.. toctree::
:maxdepth: 1
:caption: QIR API Reference
:hidden:
api/qbraid_qir
api/qbraid_qir.cirq
api/qbraid_qir.qasm3
.. toctree::
:caption: CORE API Reference
:hidden:
qbraid_core
qbraid_core.services
.. toctree::
:caption: PYQASM API Reference
:hidden:
pyqasm