Installation

Stable release

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

Optional zhinst backend

The zhinst backend is not installed by default. To install this optional dependency, please run

$ pip install quantify-scheduler[zhinst]

additional requirements

The zhinst backend is currently compatible with Python versions 3.8 and 3.9. When importing anything from the zhinst backend, an error is raised when either the backend is not installed, or when using an incorrect Python version:

ModuleNotFoundError: The zhinst backend could not be found. Please install the zhinst backend via `pip install quantify-scheduler[zhinst]`.

RuntimeError: The zhinst backend is only compatible with Python 3.8 and Python 3.9, but you have Python 3.10. Please install a compatible python version.

Update to the 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.