qiskit-qasm2

Importer from OpenQASM 2 to Qiskit

[!IMPORTANT]

This package is obsolete. It was vendored into Qiskit itself as of qiskit==0.43.0 (via qiskit-terra==0.24.0 at the time), at version 0.5.3 of this package. There is no longer any need to install this package; simply use qiskit.qasm2.load or qiskit.qasm2.loads. The Qiskit version is actively developed, and this package is not being updated any more.

All references to Qiskit in the README and in the package itself mean Qiskit versions <0.43, before this package was vendored into Qiskit.

This repository provides the Python package qiskit_qasm2, which provides a fast parser of OpenQASM 2 into Qiskit's QuantumCircuit. It is often 10x or more faster than Qiskit's native parser. The API is simple:

• qiskit_qasm2.load takes a filename, and returns QuantumCircuit;
• qiskit_qasm2.loads takes an OpenQASM 2 program in a string, and returns QuantumCircuit.

The full documentation is published to https://jakelishman.github.io/qiskit-qasm2.

A simple parsing example:

import qiskit_qasm2
program = """
    OPENQASM 2.0;
    include "qelib1.inc";
    qreg q[2];
    creg c[2];

    h q[0];
    cx q[0], q[1];

    measure q -> c;
"""
qiskit_qasm2.loads(program).draw()

     ┌───┐     ┌─┐
q_0: ┤ H ├──■──┤M├───
     └───┘┌─┴─┐└╥┘┌─┐
q_1: ─────┤ X ├─╫─┤M├
          └───┘ ║ └╥┘
c: 2/═══════════╩══╩═
                0  1

Features

The parser supports all of the OpenQASM 2 specification, including:

• register definitions and usage (qreg and creg);
• the qelib1.inc as a special builtin include, precisely as described in the paper;
• general includes, with an option to specify the search path;
• custom gate and opaque declarations;
• gate, measurement and reset broadcasting;
• conditioned gate applications, measurements and reset;
• constant folding with the scientific calculator functions in gate parameter lists;
• mathematical expressions on parameters within custom gate bodies.

In addition, the parser also includes options to:

• modify the search path for include statements in OpenQASM 2;
• define overrides for how some named OpenQASM 2 gate applications should be converted into Qiskit form;
• define new builtin quantum instructions for OpenQASM 2;
• define new builtin classical scientific-calculator functions.

Qiskit's builtin parser makes some extra-spec additions by default, with no option to disable them. This mostly takes the form of custom gate overrides, and various additional gates in Terra's vendored version of qelib1.inc compared to the description in the paper. This parser is more type-safe than Qiskit's, but does include a compatibility mode to ease the transition from using Qiskit's parser.

Installation

Install the latest release of the qiskit_qasm2 package from pip:

pip install qiskit_qasm2

Developing

If you're looking to contribute to this project, please first read our contributing guidelines.

Set up your development environment by installing the development requirements with pip:

pip install -r requirements-dev.txt tox

This installs a few more packages than the dependencies of the package at runtime, because there are some tools we use for testing also included, such as tox and pytest.

You will also need a working Rust toolchain. The easiest way to install one is by using rustup on Linux, macOS or Windows.

After the development requirements are installed, you can install an editable version of the package with

pip install -e .

After this, any changes you make to the library code will immediately be present when you open a new Python interpreter session.

This package was mostly an excuse for me to learn a bit more about how lexers are written at a low level. This is why the Rust crate doesn't use any lexer-generation libraries. You can read a bit more about the architecture and some of the design decisions in the developer section of the documentation.

Building documentation

After the development requirements have been installed, the command

tox -e docs

will build the HTML documentation, and place it in docs/_build/html. The documentation state of the main branch of this repository is published to https://jakelishman.github.io/qiskit-qasm2.

Code style and linting

The Python components of this repository are formatted using black, and the Rust components with rustfmt. You can run these on the required files by running

tox -e style

The full lint suite can be run with

tox -e lint

License

This project is licensed under version 2.0 of the Apache License.