pyqasm

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

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:

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:

>>> import pyqasm
>>> pyqasm.__version__

Resources

• API Reference: Developer documentation.
• Usage Examples: Scripts and Markdown examples demonstrating core functionality.
• Supported Operations: OpenQASM language features supported, in progress, and planned for future support.

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

License

GNU General Public License v3.0