qbraid-qir

qBraid-SDK QIR transpiler integration

https://github.com/qbraid/qbraid-qir

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
2 of 10 committers (20.0%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.5%) to scientific vocabulary

Keywords

cirq llvm openqasm python qbraid qir quantum

Keywords from Contributors

quantum-computing ahs rustworkx transpiler mesh interactive

Last synced: 6 months ago · JSON representation ·

Repository

qBraid-SDK QIR transpiler integration

Basic Info

Host: GitHub
Owner: qBraid
License: apache-2.0
Language: Python
Default Branch: main
Homepage: https://docs.qbraid.com/qir
Size: 1000 KB

Statistics

Stars: 18
Watchers: 3
Forks: 16
Open Issues: 11
Releases: 10

Topics

cirq llvm openqasm python qbraid qir quantum

Created about 2 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation

README.md

qbraid-qir-header

qBraid-SDK extension providing support for QIR conversions.

Motivation

qir

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:

shell pip install qbraid-qir

Optional dependencies

qBraid-QIR offers integrations that require extra (optional) dependencies, which can be installed as follows:

For OpenQASM 3 to QIR conversions, install the qasm3 extra:

shell pip install 'qbraid-qir[qasm3]'

For Cirq to QIR conversions, install the cirq extra:

shell pip install 'qbraid-qir[cirq]'

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:

shell 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.

shell pip install '.[qasm3,cirq]'

Check version

You can view the version of qbraid-qir you have installed within a Python shell as follows:

```python import qbraid_qir

qbraidqir.version_ ```

Resources

Usage examples

OpenQASM 3 conversions

```python from qbraidqir import qasm3to_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 = qasm3toqir(program, name="my-program")

ir = str(module) ```

Cirq conversions

```python import cirq from qbraidqir import cirqto_qir

q0, q1 = cirq.LineQubit.range(2)

circuit = cirq.Circuit( cirq.H(q0), cirq.CNOT(q0, q1), cirq.measure(q0, q1) )

module = cirqtoqir(circuit, name="my-circuit")

ir = str(module) ```

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).

architecture

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, or other topics, join our discord community
For questions that are more suited for a forum, post to QCSE with the qbraid tag.
By participating, you are expected to uphold our code of conduct.

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.

bibtex @software{Gupta_qBraid-QIR_Python_package_2025, author = {Gupta, Harshit and Hill, Ryan James}, license = {Apache-2.0}, month = jun, title = {{qBraid-QIR: Python package for QIR conversions, integrations, and utilities.}}, url = {https://github.com/qBraid/qbraid-qir}, version = {0.4.0}, year = {2025} }

Acknowledgements

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

License

Apache-2.0 License

Owner

Name: qBraid
Login: qBraid
Kind: organization
Email: contact@qbraid.com
Location: United States of America

Website: https://qbraid.com/
Twitter: qbraid_official
Repositories: 9
Profile: https://github.com/qBraid

Quantum Computing Platform

Citation (CITATION.cff)

cff-version: 1.2.0
title: 'qBraid-QIR: Python package for QIR conversions, integrations, and utilities.'
message: If you use this software, please cite it using the metadata from this file.
type: software
authors:
- given-names: Harshit
  family-names: Gupta
  affiliation: qBraid Co.
- given-names: Ryan James
  family-names: Hill
  affiliation: qBraid Co.
repository-code: https://github.com/qBraid/qbraid-qir
url: https://sdk.qbraid.com/qbraid-qir
repository-artifact: https://github.com/qBraid/qbraid-qir/releases/tag/v0.4.0
keywords:
- python
- quantum-computing
- qir
- llvm
- cirq
- openasm
license: Apache-2.0
version: 0.4.0
date-released: '2025-06-17'

GitHub Events

Total

Create event: 40
Release event: 3
Issues event: 21
Watch event: 3
Delete event: 57
Issue comment event: 94
Push event: 77
Pull request review comment event: 33
Pull request review event: 49
Pull request event: 91
Fork event: 8

Last Year

Create event: 40
Release event: 3
Issues event: 21
Watch event: 3
Delete event: 57
Issue comment event: 94
Push event: 77
Pull request review comment event: 33
Pull request review event: 49
Pull request event: 91
Fork event: 8

Committers

Last synced: about 1 year ago

All Time

Total Commits: 264
Total Committers: 10
Avg Commits per committer: 26.4
Development Distribution Score (DDS): 0.47

Past Year

Commits: 216
Committers: 10
Avg Commits per committer: 21.6
Development Distribution Score (DDS): 0.5

Top Committers

Name	Email	Commits
Ryan Hill	r**8@g**m	140
TheGupta2012	h**5@g**m	63
dependabot[bot]	4****]	19
skushnir123	s**r@g**m	16
Rohan Jain	r**n@i**u	16
king-p3nguin	k**a@g**p	4
Edward Thomas	e**s@p**m	3
olgOk	v**v@g**m	1
Sola85	t**5@g**m	1
Priyansh Parakh	p**h@P**l	1

Committer Domains (Top 20 + Academic)

g.ecc.u-tokyo.ac.jp: 1 imsa.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 47
Total pull requests: 134
Average time to close issues: about 2 months
Average time to close pull requests: 1 day
Total issue authors: 8
Total pull request authors: 13
Average comments per issue: 1.09
Average comments per pull request: 0.59
Merged pull requests: 111
Bot issues: 0
Bot pull requests: 38

Past Year

Issues: 13
Pull requests: 68
Average time to close issues: about 1 month
Average time to close pull requests: 1 day
Issue authors: 5
Pull request authors: 9
Average comments per issue: 0.85
Average comments per pull request: 0.81
Merged pull requests: 52
Bot issues: 0
Bot pull requests: 24

View more stats

Top Authors

Issue Authors

ryanhill1 (30)
TheGupta2012 (20)
rjain37 (9)
Sola85 (3)
christian512 (1)
priyansh-1902 (1)
Tarun-Kumar07 (1)
skushnir123 (1)

Pull Request Authors

ryanhill1 (82)
dependabot[bot] (51)
TheGupta2012 (50)
rjain37 (7)
skushnir123 (7)
github-actions[bot] (3)
feelerx (3)
sharminafrose (2)
arulandu (2)
kingjosmel (2)
Gmin2 (1)
king-p3nguin (1)
ejthomas (1)
olgOk (1)
priyansh-1902 (1)

Top Labels

Issue Labels

enhancement (37) qasm3 (22) bug (6) pyqir (5) parser (5) discussion (4) good first issue (3) unitary-hack (3) testing (2) wontfix (2) cirq (2) application (2) ci/cd (2) code-quality (2) llvm (1) error-handling (1) ast (1)

Pull Request Labels

dependencies (51) github_actions (12) python (4) pyqir (1) do-not-merge (1) enhancement (1) qasm3 (1)

Packages

Total packages: 1
Total downloads:
- pypi 2,178 last-month

Total dependent packages: 1
Total dependent repositories: 0
Total versions: 20
Total maintainers: 2

pypi.org: qbraid-qir

qBraid-SDK extension providing support for QIR conversions.

Homepage: https://github.com/qBraid/qbraid-qir
Documentation: https://docs.qbraid.com/qir
License: Apache 2.0
Latest release: 0.4.0
published 8 months ago

Versions: 20
Dependent Packages: 1
Dependent Repositories: 0
Downloads: 2,178 Last month

Rankings

Dependent packages count: 10.1%

Average: 38.3%

Dependent repos count: 66.5%

Maintainers (2)

ryanhill1 qBraid

Last synced: 6 months ago

Dependencies

.github/workflows/docs.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/format.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/main.yml actions

actions/checkout v3 composite
actions/download-artifact v3 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite

.github/workflows/pre-release.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
pypa/gh-action-pypi-publish release/v1 composite

.github/workflows/publish.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
pypa/gh-action-pypi-publish release/v1 composite

test-containers/qir_runner/Dockerfile docker

jupyter/minimal-notebook latest build

docs/requirements.txt pypi

docutils <0.21
sphinx *
sphinx-autodoc-typehints >=1.24,<1.26
sphinx-rtd-theme *

pyproject.toml pypi

requirements-dev.txt pypi

black * development
isort * development
pylint * development
pytest * development
pytest-cov * development
qbraid * development

requirements.txt pypi

cirq-core *
pyqir *

setup.py pypi