{"id":18724330,"url":"https://github.com/qbraid/qbraid-qir","last_synced_at":"2025-10-08T12:40:42.225Z","repository":{"id":216859720,"uuid":"724194968","full_name":"qBraid/qbraid-qir","owner":"qBraid","description":"qBraid-SDK QIR transpiler integration","archived":false,"fork":false,"pushed_at":"2025-09-22T14:10:59.000Z","size":1042,"stargazers_count":19,"open_issues_count":14,"forks_count":15,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-25T15:36:42.898Z","etag":null,"topics":["cirq","llvm","openqasm","python","qbraid","qir","quantum"],"latest_commit_sha":null,"homepage":"https://docs.qbraid.com/qir","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qBraid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-11-27T15:32:12.000Z","updated_at":"2025-09-08T07:04:11.000Z","dependencies_parsed_at":"2024-01-13T09:20:05.203Z","dependency_job_id":"635b0e82-922e-4ed7-ab48-9952a7a6a916","html_url":"https://github.com/qBraid/qbraid-qir","commit_stats":{"total_commits":260,"total_committers":10,"mean_commits":26.0,"dds":0.4653846153846154,"last_synced_commit":"02598861410ca6a4843c7b890cee5f01cfec56f3"},"previous_names":["qbraid/qbraid-qir"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/qBraid/qbraid-qir","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qBraid%2Fqbraid-qir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qBraid%2Fqbraid-qir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qBraid%2Fqbraid-qir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qBraid%2Fqbraid-qir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qBraid","download_url":"https://codeload.github.com/qBraid/qbraid-qir/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qBraid%2Fqbraid-qir/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278947776,"owners_count":26073733,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cirq","llvm","openqasm","python","qbraid","qir","quantum"],"created_at":"2024-11-07T14:05:58.081Z","updated_at":"2025-10-08T12:40:42.186Z","avatar_url":"https://github.com/qBraid.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg width=\"full\" alt=\"qbraid-qir-header\" src=\"https://github.com/qBraid/qbraid-qir/assets/46977852/39f921ae-c4bf-442a-b059-6b21abd2ae50\"\u003e\n\n\u003cp align='center'\u003e\n  \u003ca href='https://github.com/qBraid/qbraid-qir/actions/workflows/main.yml'\u003e\n      \u003cimg src='https://github.com/qBraid/qbraid-qir/actions/workflows/main.yml/badge.svg' alt='CI'\u003e\n  \u003c/a\u003e\n  \u003ca href='https://sdk.qbraid.com/qbraid-qir/'\u003e\n    \u003cimg src='https://img.shields.io/github/actions/workflow/status/qBraid/qbraid-qir/gh-pages.yml?label=docs' alt='GitHub Pages'/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/qBraid/qbraid-qir\"\u003e\n    \u003cimg src=\"https://codecov.io/gh/qBraid/qbraid-qir/graph/badge.svg?token=GUQ3EN8DGI\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pepy.tech/projects/qbraid-qir\"\u003e\n    \u003cimg src=\"https://static.pepy.tech/badge/qbraid-qir\" alt=\"PyPI Downloads\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pypi.org/project/qbraid-qir/\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/qbraid-qir.svg?color=blue\" alt=\"PyPI version\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pypi.org/project/qbraid-qir/\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/pyversions/qbraid-qir.svg?color=blue\" alt=\"PyPI version\"/\u003e\n  \u003c/a\u003e\n  \u003ca href='http://www.apache.org/licenses/LICENSE-2.0'\u003e\n    \u003cimg src='https://img.shields.io/github/license/qBraid/qbraid-qir.svg' alt='License'/\u003e\n  \u003c/a\u003e\n  \u003ca href='https://discord.gg/TPBU2sa8Et'\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord\u0026logoColor=white\" alt=\"Discord\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nqBraid-SDK extension providing support for QIR conversions.\n\n[\u003cimg src=\"https://qbraid-static.s3.amazonaws.com/logos/Launch_on_qBraid_white.png\" width=\"150\"\u003e](https://account.qbraid.com?gitHubUrl=https://github.com/qBraid/qbraid-qir.git)\n\n## Motivation\n\n\u003cimg align=\"right\" width=\"100\" alt=\"qir\" src=\"https://qbraid-static.s3.amazonaws.com/logos/qir.png\"\u003e\n\nThis project aims to make [QIR](https://www.qir-alliance.org/) representations accessible via the qBraid-SDK [transpiler](#architecture-diagram), and by doing so, open the door to language-specific conversions from any and all high-level quantum languages [supported](https://docs.qbraid.com/sdk/user-guide/overview#supported-frontends) by `qbraid`. See QIR Alliance: [why do we need it?](https://www.qir-alliance.org/qir-book/concepts/why-do-we-need.html).\n\n## Installation\n\nqBraid-QIR requires Python 3.10 or greater, and can be installed with pip as follows:\n\n```shell\npip install qbraid-qir\n```\n\n### Optional dependencies\n\nqBraid-QIR offers integrations that require extra (optional) dependencies, which can be installed as follows:\n\nFor OpenQASM 3 to QIR conversions, install the `qasm3` extra:\n\n```shell\npip install 'qbraid-qir[qasm3]'\n```\n\nFor Cirq to QIR conversions, install the `cirq` extra:\n\n```shell\npip install 'qbraid-qir[cirq]'\n```\n\n### Install from source\n\nYou can also install from source by cloning this repository and running a pip install command\nin the root directory of the repository:\n\n```shell\ngit clone https://github.com/qBraid/qbraid-qir.git\ncd qbraid-qir\npip install .\n```\n\nTo include optional dependencies when installing from source, use the same \"extras_require\" format, e.g.\n\n```shell\npip install '.[qasm3,cirq]'\n```\n\n## Check version\n\nYou can view the version of qbraid-qir you have installed within a Python shell as follows:\n\n```python\nimport qbraid_qir\n\nqbraid_qir.__version__\n```\n\n## Resources\n\n- [User Guide](https://docs.qbraid.com/qir/user-guide)\n- [API Reference](https://sdk.qbraid.com/qbraid-qir/api/qbraid_qir.html)\n- [Example Notebooks](https://github.com/qBraid/qbraid-lab-demo/tree/main/qbraid_qir)\n- [Docker Containers](docker)\n\n## Usage examples\n\n### OpenQASM 3 conversions\n\n```python\nfrom qbraid_qir import qasm3_to_qir\n\nprogram = \"\"\"\nOPENQASM 3;\ninclude \"stdgates.inc\";\n\nqubit[2] q;\nbit[2] c;\n\nh q[0];\ncx q[0], q[1];\n\nmeasure q[0] -\u003e c[0];\nmeasure q[1] -\u003e c[1];\n\"\"\"\n\nmodule = qasm3_to_qir(program, name=\"my-program\")\n\nir = str(module)\n```\n\n### Cirq conversions\n\n```python\nimport cirq\nfrom qbraid_qir import cirq_to_qir\n\nq0, q1 = cirq.LineQubit.range(2)\n\ncircuit = cirq.Circuit(\n  cirq.H(q0),\n  cirq.CNOT(q0, q1),\n  cirq.measure(q0, q1)\n)\n\nmodule = cirq_to_qir(circuit, name=\"my-circuit\")\n\nir = str(module)\n```\n\n## Architecture diagram\n\nqBraid-SDK transpiler hub-and-spokes [architecture](https://docs.qbraid.com/qir/user-guide/overview#architecture-diagram) with qbraid-qir integration (left) mapped to language specific conversion step in QIR abstraction [layers](https://www.qir-alliance.org/qir-book/concepts/why-do-we-need.html) (right).\n\n\u003cimg width=\"full\" alt=\"architecture\" src=\"https://github.com/qBraid/qbraid-qir/assets/46977852/36644614-2715-4f08-8a8c-8a2e61aebf38\"\u003e\n\n## Contributing\n\n- Interested in contributing code, or making a PR? See\n  [CONTRIBUTING.md](CONTRIBUTING.md)\n- For feature requests and bug reports:\n  [Submit an issue](https://github.com/qBraid/qbraid-qir/issues)\n- For discussions, and specific questions about qBraid-QIR, or\n  other topics, [join our discord community](https://discord.gg/TPBU2sa8Et)\n- For questions that are more suited for a forum, post to\n  [QCSE](https://quantumcomputing.stackexchange.com/)\n  with the [`qbraid`](https://quantumcomputing.stackexchange.com/questions/tagged/qbraid) tag.\n- By participating, you are expected to uphold our [code of conduct](CODE_OF_CONDUCT).\n\n## Citation\n\nIf you use qBraid-QIR in your research, we kindly request that you cite it appropriately.\nThe BibTeX entry below is aligned with the latest stable release. For the most up-to-date\ncitation details, please refer to [CITATION.cff](CITATION.cff).\n\n```bibtex\n@software{Gupta_qBraid-QIR_Python_package_2025,\n  author = {Gupta, Harshit and Hill, Ryan James},\n  license = {Apache-2.0},\n  month = jun,\n  title = {{qBraid-QIR: Python package for QIR conversions, integrations, and utilities.}},\n  url = {https://github.com/qBraid/qbraid-qir},\n  version = {0.4.0},\n  year = {2025}\n}\n```\n\n## Acknowledgements\n\nThis project was conceived in cooperation with the Quantum Open Source Foundation ([QOSF](https://qosf.org/)).\n\n\u003ca href=\"https://qosf.org/\"\u003e\u003cimg src=\"https://qbraid-static.s3.amazonaws.com/logos/qosf.png\" width=\"100px\" style=\"vertical-align: middle;\" /\u003e\u003c/a\u003e\n\n## License\n\n[Apache-2.0 License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqbraid%2Fqbraid-qir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqbraid%2Fqbraid-qir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqbraid%2Fqbraid-qir/lists"}