Get the source code¶

Warning

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

After you have installed the prerequisites, use Git to get a copy of the pycompwa source code. To do so, navigate to a suitable folder and run:

git clone --recurse-submodules git@github.com:ComPWA/pycompwa.git

This will take a few minutes, because the source code for ComPWA and its submodules will also be downloaded.

After that, there should be a folder called pycompwa. We’ll call this folder the local repository. If you navigate into it, you can see it has:

a pycompwa folder with Python source code
a ComPWA folder with C++ source code
a requirements.txt file listing the Python dependencies
a setup.py file with instructions for setuptools
a CMakeLists.txt file for if you build with cmake (in developer mode)

These files will be used in the following steps.

Note

When new commits are merged into the main branch of pycompwa, you need to update your local copy of the source code. It’s important that you also update the submodules:

git checkout main
git pull --recurse-submodules

It’s best to have a clean your working tree before you do a git pull. See Help developing for more info.

Once you have the update, don’t forget to rebuild pycompwa!