Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/qbraid/pyqasm

Python toolkit providing OpenQASM 3 semantic analyzer and utilities for program analysis and compilation.
https://github.com/qbraid/pyqasm

openqasm quantum-computing

Last synced: about 2 months ago
JSON representation

Python toolkit providing OpenQASM 3 semantic analyzer and utilities for program analysis and compilation.

Host: GitHub
URL: https://github.com/qbraid/pyqasm
Owner: qBraid
License: gpl-3.0
Created: 2024-10-04T16:15:04.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-10-24T12:55:26.000Z (3 months ago)
Last Synced: 2024-10-25T08:54:39.097Z (3 months ago)
Topics: openqasm, quantum-computing
Language: Python
Homepage: https://sdk.qbraid.com/projects/pyqasm
Size: 405 KB
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # pyqasm



[![CI](https://github.com/qBraid/pyqasm/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/qBraid/pyqasm/actions/workflows/main.yml)

[![codecov](https://codecov.io/gh/qBraid/pyqasm/graph/badge.svg?token=92YURMR8T8)](https://codecov.io/gh/qBraid/pyqasm)

[![Documentation Status](https://readthedocs.com/projects/qbraid-pyqasm/badge/?version=latest&token=d5432c6f40d942b391982fc88183389938a0e930ae5e588cf579e9ab1e3319a0)](https://qbraid-pyqasm.readthedocs-hosted.com/en/latest/?badge=latest)

[![PyPI version](https://img.shields.io/pypi/v/pyqasm.svg?color=blue)](https://pypi.org/project/pyqasm/)

[![Python verions](https://img.shields.io/pypi/pyversions/pyqasm.svg?color=blue)](https://pypi.org/project/pyqasm/)

[![License](https://img.shields.io/github/license/qBraid/pyqasm.svg?color=purple)](https://www.gnu.org/licenses/gpl-3.0.html)

Python toolkit providing an OpenQASM 3 semantic analyzer and utilities for program analysis and compilation.

>[!WARNING]

> **This project is "pre-alpha", and is not yet stable or fully realized. Use with caution, as the API and functionality are subject to significant changes.**

## Motivation

[OpenQASM](https://openqasm.com/) is a powerful language for expressing hybrid quantum-classical programs, but it lacks a comprehensive tool supporting the full capabilities of the language. PyQASM aims to fill this gap by building upon the [`openqasm3.parser`](https://github.com/openqasm/openqasm/blob/ast-py/v1.0.0/source/openqasm/openqasm3/parser.py), and providing support for semantic analysis and utilities for program compilation.

## Installation

PyQASM requires Python 3.10 or greater, and can be installed with pip as follows:

```bash

pip install pyqasm

```

### 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:

```bash

git clone https://github.com/qBraid/pyqasm.git

cd pyqasm

pip install .

```

## Check version

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

```python

>>> import pyqasm

>>> pyqasm.__version__

```

## Resources

- [API Reference](https://sdk.qbraid.com/projects/pyqasm/en/stable/): Developer documentation.

- [Usage Examples](examples): Scripts and Markdown examples demonstrating core functionality.

- [Supported Operations](pyqasm/README.md#supported-operations): OpenQASM language features supported, in progress, and planned for future support.

## Contributing

[![GitHub](https://img.shields.io/badge/issue_tracking-github-black?logo=github)](https://github.com/qBraid/pyqasm/issues)

[![QCSE](https://img.shields.io/badge/QCSE-pyqasm-orange?logo=stackexchange)](https://quantumcomputing.stackexchange.com/questions/tagged/pyqasm)

[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.gg/TPBU2sa8Et)

- Interested in contributing code, or making a PR? See

  [CONTRIBUTING.md](CONTRIBUTING.md)

- For feature requests and bug reports:

  [Submit an issue](https://github.com/qBraid/pyqasm/issues)

- For discussions, and specific questions about pyqasm, or

  other topics, [join our discord community](https://discord.gg/TPBU2sa8Et)

- For questions that are more suited for a forum, post to

  [QCSE](https://quantumcomputing.stackexchange.com/)

  with the [`pyqasm`](https://quantumcomputing.stackexchange.com/questions/tagged/pyqasm) tag.

- By participating, you are expected to uphold our [code of conduct](CODE_OF_CONDUCT).

## License

[GNU General Public License v3.0](LICENSE)