Skip to main content

Q-CTRL Qiskit Adapter

Project description

Q-CTRL Qiskit Adapter

The aim of the Q-CTRL Qiskit Adapter package is to provide export functions allowing users to deploy established error-robust quantum control protocols from the open literature and defined in Q-CTRL Open Controls on IBM Quantum hardware.

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

Table of Contents


Q-CTRL Qiskit Adapter can be installed 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 Qiskit Adapter 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.

Using PyPi

Use pip to install the latest version of Q-CTRL Qiskit Adapter.

pip install qctrl-qiskit

From Source

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

git clone

Once the clone is complete, you have two options:

  1. Using

    cd python-qiskit
    python develop

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

  2. Using Poetry

    cd python-qiskit

    Note: if you are on Windows, you'll need to install Poetry manually, and use:

    cd python-qiskit
    poetry install

Once installed via one of the above methods, test your installation by running pytest in the python-qiskit directory.



See the Jupyter notebooks.


For general guidelines, see Contributing.

Building documentation

Documentation generation relies on Spinx. Automated builds are done by Read The Docs.

To build locally:

  1. Ensure you have used one of the install options above.

  2. Execute the make file from the docs directory:

    If using Poetry:

    cd docs
    poetry run make html

    If using setuptools:

    cd docs
    # Activate your virtual environment if required
    make html

The generated HTML will appear in the docs/_build/html directory.


See Contributors.



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for qctrl-qiskit, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size qctrl_qiskit-0.0.3-py3-none-any.whl (10.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size qctrl-qiskit-0.0.3.tar.gz (10.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page