Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

ComPWA/pycompwa

Repository files navigation

About pycompwa

10.5281/zenodo.3479232 GPLv3+ license

GitHub Actions Codecov PyPI package Supported Python versions Codacy pre-commit.ci status Spelling checked code style: prettier Code style: black Imports: isort

pycompwa is a collection of python modules and the python interface to ComPWA. ComPWA stands for "Common Partial Wave Analysis framework".

Analogous to ComPWA, pycompwa's highest focus is also modularity. pycompwa extends the ComPWA framework with some useful modules:

  • expertsystem
    A python package that can generate amplitude/intensity model files from simple user boundary conditions, such as initial and final state. Currently supports the helicity and canonical formalism.

  • ui
    The python interface to ComPWA, allowing easy steering of ComPWA.

  • plotting
    Facilitates the visualization of data and results, i.e. comparison plots, Dalitz plots.

Installation

Detailed instructions can be found here. Make sure the virtual environment is setup and activated.

Installation via pypi

pip install pycompwa

Installation from source

git clone --recurse-submodules git@github.com:ComPWA/pycompwa.git
cd pycompwa
python setup.py install -j4

(replace 4 with the number of cores on your machine, or use $(nproc)).

Usage

On how to use ComPWA please refer to the pycompwa workflow examples.

Documentation

The documentation can be found here.