Installation

The fastest way of installing this package is through PyPI:

python3 -m pip install ampform

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/ampform@main

In that case, however, we highly recommend using the more dynamic ‘editable installation’ instead. This goes as follows:

  1. Get the source code:

    git clone https://github.com/ComPWA/ampform.git
    cd ampform
    
  2. [Recommended] Create a virtual environment (see here).

  3. Install the project as an ‘editable installation’ and install additional packages for the developer:

    python3 -m pip install -e .[dev]
    

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