Skip to content

index.rst

Latest commit

 

History

History
184 lines (129 loc) · 4.13 KB

index.rst

File metadata and controls

184 lines (129 loc) · 4.13 KB
Raw

Documentation

* { box-sizing: border-box; } body { font-family: Arial, Helvetica, sans-serif; } /* Float four columns side by side */ .column { display: inline-block; vertical-align: middle; float: none; width: 25%; padding: 0 10px; } /* Remove extra left and right margins, due to padding */ .row { text-align: center; margin:0 auto; } /* Clear floats after the columns */ .row:after { content: ""; display: table; clear: both; } /* Responsive columns */ @media screen and (max-width: 600px) { .column { width: 100%; margin-bottom: 20px; } }

qbraid logo qBraid | QIR

qBraid-SDK extension providing support for QIR conversions.


Release:|release|

Python package for generating QIR programs from Cirq, and other high-level quantum programming languages. This project aims to make QIR (Quantum Intermediate Representation) 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.

"Interoperability opens doors to cross-fields problem-solving." - QIR Alliance: Why do we need it?.

Installation

pip install qbraid-qir

Test container

Docker image providing an environment for testing and executing QIR programs with the qir-runner package.

Clone the qbraid-qir repository:

git clone https://github.com/qBraid/qbraid-qir.git
cd qbraid-qir

Build the QIR runner image:

docker build -t qbraid-test/qir-runner:latest qir_runner

Start the container running a Jupyter Server with the JupyterLab frontend and expose the container's internal port 8888 to port 8888 of the host machine:

docker run -p 8888:8888 qbraid-test/qir-runner:latest

Visiting http://<hostname>:8888/?token=<token> in a browser will launch JupyterLab, where:

  • The hostname is the name of the computer running Docker (e.g. localhost)
  • The token is the secret token printed in the console.

Alternatively, you can open a shell inside the running container directly:

docker exec -it <container_name> /bin/bash
.. seealso::

   https://github.com/qBraid/qbraid-qir/tree/main/test-containers

Acknowledgements

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

qir qbraid cirq qosf 

.. toctree::
   :maxdepth: 1
   :caption: User Guide
   :hidden:

   userguide/cirq_qir
   userguide/qasm3_qir


.. toctree::
   :maxdepth: 1
   :caption: API Reference
   :hidden:

   api/qbraid_qir
   api/qbraid_qir.cirq
   api/qbraid_qir.qasm3

Indices and Tables