PyPI package Conda package Supported Python versions

Quick installation#

The fastest way of installing this package is through PyPI or Conda:

python3 -m pip install qrules
conda install -c conda-forge qrules

This installs the latest release that you can find on the stable branch.

Optionally, you can install the dependencies required for visualizing topologies with the following optional dependency syntax:

pip install qrules[viz]  # installs qrules with graphviz

The latest version on the main branch can be installed as follows:

python3 -m pip install git+

Editable installation#

It is highly recommend to use the more dynamic ā€˜editable installationā€™. This allows you to:

For this, you first need to get the source code with Git:

git clone
cd qrules

Next, you install the project in editable mode with either Conda or pip. Itā€™s recommended to use Conda, because this also pins the version of Python.

conda env create

This installs the project in a Conda environment following the definitions in environment.yml.

  1. [Recommended] Create a virtual environment with venv (see here).

  2. Install the project as an ā€˜editable installationā€™ with additional packages for the developer and all dependencies pinned through constraints files:

    python3 -m pip install -c .constraints/py3.x.txt -e .[dev]

See Updating for how to update the dependencies when new commits come in.

Thatā€™s all! Have a look at Usage to try out the package. You can also have a look at Help developing for tips on how to work with this ā€˜editableā€™ developer setup!