Python toolkit providing an OpenQASM 3 semantic analyzer and utilities for program analysis and compilation.
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.
PyQASM requires Python 3.10 or greater, and can be installed with pip as follows:
pip install pyqasmPyQASM provides an optional extra called pyqasm[pulse] that adds pulse/calibration features.
pip install pyqasm[pulse]PyQASM also offers optional extras for command-line interface (CLI) functionality and for program visualization.
To install the CLI tools:
pip install pyqasm[cli]To install the visualization tools:
pip install pyqasm[visualization]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 .You can view the version of pyqasm you have installed within a Python shell as follows:
>>> import pyqasm
>>> pyqasm.__version__- 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.
- 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
pyqasmtag. - By participating, you are expected to uphold our code of conduct.