Installation¶

Warning

pycompwa is no longer maintained. Use the ComPWA packages QRules, AmpForm, and TensorWaves instead!

Prerequisites¶

pycompwa is available as a PyPI package. However, since the pycompwa.ui module contains Python bindings to the ComPWA backend, you first need to install certain C++ prerequisites.

What you definitely need to install, is:

a build tool: cmake
a C++ compiler: gcc or clang
Boost
Python3

The following package are optional:

It is highly recommended to install ROOT with Minuit2 enabled. Without it, ComPWA will have only limited functionality.

Hint

If you have a Linux machine with apt and with administrator rights, you can run the following:

sudo apt update -y
sudo apt install -y cmake gcc git libboost-all-dev python3

ROOT with Minuit2 can be most easily installed by downloading a suitable binary for your machine.

Installation through pip¶

Once you have these dependencies installed, you can install pycompwa through pip. You also need to install scikit-build, because it is used as a build tool for the ComPWA backend:

pip install scikit-build
pip install pycompwa

Et voilà, that’s it! You can try out whether the installation works by running:

import pycompwa

from the Python interpreter. If that works, you can try out some of the examples from the Usage page.

Note that pip only allows you to install specific releases. We therefore recommend following the interactive installation procedure instead.

Interactive installation¶

pycompwa is an academic research project and is bound to continuously evolve. We therefore highly recommend installing pycompwa from the source code, so that you work with the latest version.

Moreover, since you read as far as this, you must have an interest in partial-wave analysis, and it is researchers like you who can help bring this project further! So please, have a look through the following sections to set up this ‘interactive installation’:

After that, it’s worth having a look at Help developing!