Skip to main content

Q-CTRL Open Controls

Project description

Q-CTRL Open Controls

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:

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

Table of Contents

Installation

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.

Requirements

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.

Using PyPi

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

pip install qctrl-open-controls

From Source

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 have two options:

  1. Using setup.py

    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.

  2. Using Poetry

    cd python-open-controls
    ./setup-poetry.sh
    

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

    cd python-open-controls
    poetry install
    

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

pytest

Usage

See the Jupyter notebooks.

Contributing

For general guidelines, see Contributing.

Building documentation

Documentation generation relies on Sphinx. 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.

Credits

See Contributors.

License

See LICENSE.

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-open-controls, version 4.1.1
Filename, size File type Python version Upload date Hashes
Filename, size qctrl_open_controls-4.1.1-py3-none-any.whl (34.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size qctrl-open-controls-4.1.1.tar.gz (27.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page