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:
Get the source code:
git clone https://github.com/ComPWA/ampform.git cd ampform
[Recommended] Create a virtual environment (see here).
Install the project as an ‘editable installation’ and install additional packages for the developer:
python3 -m pip install -e .[dev]
Pinning dependency versions
In order to install the exact same versions of the dependencies with which the framework has been tested, use the provided constraints files for the specific Python version
3.x
you are using:python3 -m pip install -c .constraints/py3.x.txt -e .[dev]
See also
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!