Installation

Stable release

To install quantify-scheduler follow the installation guide of quantify-core.

Update to latest version

To update to the latest version

$ pip install --upgrade quantify-scheduler

From sources

The sources for quantify-scheduler can be downloaded from the GitLab repo.

You can clone the public repository:

$ git clone git@gitlab.com:quantify-os/quantify-scheduler.git
$ # or if you prefer to use https:
$ # git clone https://gitlab.com/quantify-os/quantify-scheduler.git/

Once you have a copy of the source, you can install it with:

$ python -m pip install --upgrade .

Setting up for local development

In order to develop the code locally, the package can be installed in the “editable mode” with the -e flag. [dev] optional requirement set will pull all (necessary and recommended) development requirements:

$ python -m pip install -e ".[dev]"

Contributions are very welcome! To set up an environment for local development see the instructions in the installation guide of quantify-core. You only need to replace quantify-core with quantify-scheduler in the provided commands.

If you need any help reach out to us by creating a new issue.

Jupyter and Plotly

quantify-scheduler uses the ploty graphing framework for some components, which can require some additional set-up to run with a Jupyter environment - please see this page for details.