Q-CTRL Open Controls is an open-source Python package that makes it easy to create and deploy established error-robust quantum control protocols from the open literature. The aim of the package is to be the most comprehensive library of published and tested quantum control techniques developed by the community, with easy to use export functions allowing users to deploy these controls on:

• Custom quantum hardware
• Publicly available cloud quantum computers
• The Q-CTRL product suite

Anyone interested in quantum control is welcome to contribute to this project.

• Installation
• Usage
• Contributing
• Credits
• License

Q-CTRL Open Controls can be install through pip or from source. We recommend the pip distribution to get the most recent stable release. If you want the latest features then install from source.

To use Q-CTRL Open Controls you will need an installation of Python. We recommend using the Anaconda distribution of Python. Anaconda includes standard numerical and scientific Python packages which are optimally compiled for your machine. Follow the Anaconda Installation instructions and consult the Anaconda User guide to get started.

We use interactive jupyter notebooks for our usage examples. The Anaconda python distribution comes with editors for these files, or you can install the jupyter notebook editor on its own.

Use pip to install the latest version of Q-CTRL Open Controls.

$ pip install qctrl-open-controls

The source code is hosted on Github. The repository can be cloned using

$ git clone git@github.com:qctrl/python-open-controls.git

Once the clone is complete, you can run the install script.

$ cd python-open-controls
$ python setup.py develop

Note: We recommend installing using develop to point your installation at the source code in the directory where you cloned the repository.

To test your installation run pytest in the python-open-controls directory.

$ pytest

Usage depends on the application. We've provided a set of example Jupyter notebooks addressing a variety of quantum control problems. Below is a short description of each notebook grouped by application. For further details on usage, use the inline documentation in the source code.

Q-CTRL Open Controls can create a large library of standard DDS which can be exported in a variety of formats.

examples/creating_a_dds.ipynb demonstrates how to use Q-CTRL Open Controls to create a DDS from a large library of published dynamical decoupling protocols. It also shows how to make Custom DDS with timings, offsets and unitaries defined by the user. The notebook shows how to export a DDS for deployment in the Q-CTRL products or your quantum hardware.

examples/export_a_dds_to_qiskit.ipynb demonstrates how to take a DDS and convert it to a Qiskit circuit so it can be run on IBM's quantum computers. It also demonstrates using a DDS to improve the performance of a quantum circuit execution by extending the coherence time of a qubit.

examples/export_a_dds_to_cirq.ipynb demonstrates how to take a DDS and convert it to a Cirq circuit or schdule. It also shows how to run a circuit or schedule in a Cirq simulator.

See Contributing.

See Contributors.

See LICENSE.