https://github.com/compwa/ampform

Automatically generate symbolic amplitude models for Partial Wave Analysis
https://github.com/compwa/ampform

amplitude-analysis cas partial-wave-analysis pwa sympy

Last synced: 3 months ago
JSON representation

Automatically generate symbolic amplitude models for Partial Wave Analysis

• Host: GitHub
• URL: https://github.com/compwa/ampform
• Owner: ComPWA
• License: apache-2.0
• Created: 2021-04-06T12:24:38.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-18T16:28:19.000Z (over 1 year ago)
• Last Synced: 2024-12-18T16:34:05.646Z (over 1 year ago)
• Topics: amplitude-analysis, cas, partial-wave-analysis, pwa, sympy
• Language: Python
• Homepage: https://ampform.rtfd.io
• Size: 4.16 MB
• Stars: 11
• Watchers: 7
• Forks: 6
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          
# AmpForm

[![10.5281/zenodo.5526648](https://zenodo.org/badge/doi/10.5281/zenodo.5526648.svg)](https://doi.org/10.5281/zenodo.5526648)

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

[![PyPI package](https://badge.fury.io/py/ampform.svg)](https://pypi.org/project/ampform)

[![Conda package](https://anaconda.org/conda-forge/ampform/badges/version.svg)](https://anaconda.org/conda-forge/ampform)

[![Supported Python versions](https://img.shields.io/pypi/pyversions/ampform)](https://pypi.org/project/ampform)

[![Binder](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ComPWA/ampform/stable?urlpath=lab)

[![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ComPWA/ampform/blob/stable)

[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/ampform)

[![Documentation build status](https://readthedocs.org/projects/ampform/badge/?version=latest)](https://ampform.readthedocs.io)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/ampform/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/ampform/main)

[![CI status](https://github.com/ComPWA/ampform/workflows/CI/badge.svg)](https://github.com/ComPWA/ampform/actions/workflows/ci.yml?query=branch%3Amain+workflow%3Aci)

[![Test coverage](https://codecov.io/gh/ComPWA/ampform/branch/main/graph/badge.svg)](https://codecov.io/gh/ComPWA/ampform)

[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)

[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)

AmpForm is a Python library of spin formalisms and dynamics with which you can

automatically formulate symbolic amplitude models for Partial Wave Analysis. The

resulting amplitude models are formulated with

[SymPy](https://www.sympy.org/en/index.html) (a Computer Algebra System). This not only

makes it easy to inspect and visualize the resulting amplitude models, but also means

the amplitude models can be used as templates for faster computational back-ends (see

[TensorWaves](https://github.com/ComPWA/tensorwaves))!

Visit [ampform.rtfd.io](https://ampform.readthedocs.io) for several usage examples. For

an overview of **upcoming releases and planned functionality**, see

[here](https://github.com/ComPWA/ampform/milestones?direction=asc&sort=title&state=open).

## Available features

- **Automatic amplitude model building**
 Convert state transition graphs from

  [QRules](https://github.com/ComPWA/qrules) to an amplitude model that is

  _mathematically expressed_ with [SymPy](https://docs.sympy.org) and can be _converted

  to any backend_ (see [TensorWaves](https://tensorwaves.rtfd.io)).

- **Spin formalisms**

  - [Helicity formalism](https://ampform.readthedocs.io/en/stable/amplitude/formalism.html)

  - Canonical formalism

  - [Spin alignment](https://ampform.readthedocs.io/en/stable/amplitude/spin-alignment.html)

    for generic, multi-body decays that feature different decay topologies. **See also [`ampform-dpd`](https://github.com/ComPWA/ampform-dpd)!**

- **Dynamics**

  - [Relativistic Breit–Wigner](https://ampform.readthedocs.io/en/stable/api/ampform.dynamics.html#ampform.dynamics.relativistic_breit_wigner_with_ff),

    optionally with form factors and/or

    [energy-dependent width](https://ampform.readthedocs.io/en/stable/api/ampform.dynamics.html#ampform.dynamics.EnergyDependentWidth)

  - [Symbolic _K_-matrix](https://ampform.readthedocs.io/en/stable/dynamics/k-matrix.html#non-relativistic-k-matrix)

    for an arbitrary number of poles and channels

  - [Symbolic _P_-vector](https://ampform.readthedocs.io/en/stable/dynamics/k-matrix.html#p-vector)

    for an arbitrary number of poles and channels

  - Chew–Mandelstam dispersion integral for a correct treatment of analyticity in the presence of thresholds.

## Contribute

See [`CONTRIBUTING.md`](./CONTRIBUTING.md)