Installation¶
The fastest way of installing this package is through PyPI:
python3 -m pip install qrules
This installs the latest, stable release
that you can find on the
stable
branch. The latest
version on the main
branch can
be installed as follows:
python3 -m pip install git+https://github.com/ComPWA/qrules@main
In that case, however, we highly recommend using the more dynamic, ‘editable installation’ instead. This goes as follows:
Get the source code (see Working with Git):
git clone https://github.com/ComPWA/qrules.git cd qrules
[Recommended] Create a virtual environment (see here).
Install the project in ‘editable installation’, as well as additional dependencies for the developer:
# pin dependencies first! python3 -m pip install -r reqs/PYTHON_VERSION/requirements-dev.txt python3 -m pip install -e .
That’s all! Have a look at the Usage page to try out the package, and see Develop for tips on how to work with this ‘editable’ developer setup!