Installation#
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+https://github.com/ComPWA/qrules@main
Editable installation#
It is highly recommend to use the more dynamic āeditable installationā. This allows you to:
exactly pin all dependencies to a specific version, so that your work is reproducible.
edit the source code of the framework and help improving it.
For this, you first need to get the source code with Git:
git clone https://github.com/ComPWA/qrules.git
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
.
[Recommended] Create a virtual environment with
venv
(see here).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!