# AmpForm
[](https://doi.org/10.5281/zenodo.5526648)
[](https://www.gnu.org/licenses/gpl-3.0-standalone.html)
[](https://pypi.org/project/ampform)
[](https://anaconda.org/conda-forge/ampform)
[](https://pypi.org/project/ampform)
[](https://mybinder.org/v2/gh/ComPWA/ampform/stable?filepath=docs/usage)
[](https://colab.research.google.com/github/ComPWA/ampform/blob/stable)
[](https://open.vscode.dev/ComPWA/ampform)
[](https://gitpod.io/#https://github.com/ComPWA/ampform)
[](https://ampform.readthedocs.io)
[](https://results.pre-commit.ci/latest/github/ComPWA/ampform/main)
[](https://github.com/ComPWA/ampform/actions?query=branch%3Amain+workflow%3Apytest)
[](https://mypy.readthedocs.io)
[](https://codecov.io/gh/ComPWA/ampform)
[](https://www.codacy.com/gh/ComPWA/ampform)
[](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
[](https://github.com/prettier/prettier)
[](https://github.com/astral-sh/ruff)
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**<br /> 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/usage/helicity/formalism.html)
- Canonical formalism
- [Spin alignment](https://ampform.readthedocs.io/en/stable/usage/helicity/spin-alignment.html)
for generic, multi-body decays that feature different decay topologies
- **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/usage/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/usage/dynamics/k-matrix.html#p-vector)
for an arbitrary number of poles and channels
## Contribute
See [`CONTRIBUTING.md`](./CONTRIBUTING.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "ampform",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "compwa-admin@ep1.rub.de",
"keywords": "HEP, PWA, amplitude analysis, partial wave analysis, particle physics, particles, physics",
"author": null,
"author_email": "Common Partial Wave Analysis <compwa-admin@ep1.rub.de>",
"download_url": "https://files.pythonhosted.org/packages/87/5b/bad0dfe0fc7088f29304359e0394b686d28c17bf12d8968ecfd363c22bb4/ampform-0.15.3.tar.gz",
"platform": null,
"description": "# AmpForm\n\n[](https://doi.org/10.5281/zenodo.5526648)\n[](https://www.gnu.org/licenses/gpl-3.0-standalone.html)\n\n[](https://pypi.org/project/ampform)\n[](https://anaconda.org/conda-forge/ampform)\n[](https://pypi.org/project/ampform)\n\n[](https://mybinder.org/v2/gh/ComPWA/ampform/stable?filepath=docs/usage)\n[](https://colab.research.google.com/github/ComPWA/ampform/blob/stable)\n[](https://open.vscode.dev/ComPWA/ampform)\n[](https://gitpod.io/#https://github.com/ComPWA/ampform)\n\n[](https://ampform.readthedocs.io)\n[](https://results.pre-commit.ci/latest/github/ComPWA/ampform/main)\n[](https://github.com/ComPWA/ampform/actions?query=branch%3Amain+workflow%3Apytest)\n[](https://mypy.readthedocs.io)\n[](https://codecov.io/gh/ComPWA/ampform)\n[](https://www.codacy.com/gh/ComPWA/ampform)\n[](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)\n[](https://github.com/prettier/prettier)\n[](https://github.com/astral-sh/ruff)\n\nAmpForm is a Python library of spin formalisms and dynamics with which you can\nautomatically formulate symbolic amplitude models for Partial Wave Analysis. The\nresulting amplitude models are formulated with\n[SymPy](https://www.sympy.org/en/index.html) (a Computer Algebra System). This not only\nmakes it easy to inspect and visualize the resulting amplitude models, but also means\nthe amplitude models can be used as templates for faster computational back-ends (see\n[TensorWaves](https://github.com/ComPWA/tensorwaves))!\n\nVisit [ampform.rtfd.io](https://ampform.readthedocs.io) for several usage examples. For\nan overview of **upcoming releases and planned functionality**, see\n[here](https://github.com/ComPWA/ampform/milestones?direction=asc&sort=title&state=open).\n\n## Available features\n\n- **Automatic amplitude model building**<br /> Convert state transition graphs from\n [QRules](https://github.com/ComPWA/qrules) to an amplitude model that is\n _mathematically expressed_ with [SymPy](https://docs.sympy.org) and can be _converted\n to any backend_ (see [TensorWaves](https://tensorwaves.rtfd.io)).\n- **Spin formalisms**\n - [Helicity formalism](https://ampform.readthedocs.io/en/stable/usage/helicity/formalism.html)\n - Canonical formalism\n - [Spin alignment](https://ampform.readthedocs.io/en/stable/usage/helicity/spin-alignment.html)\n for generic, multi-body decays that feature different decay topologies\n- **Dynamics**\n - [Relativistic Breit-Wigner](https://ampform.readthedocs.io/en/stable/api/ampform.dynamics.html#ampform.dynamics.relativistic_breit_wigner_with_ff),\n optionally with form factors and/or\n [energy-dependent width](https://ampform.readthedocs.io/en/stable/api/ampform.dynamics.html#ampform.dynamics.EnergyDependentWidth)\n - [Symbolic _K_-matrix](https://ampform.readthedocs.io/en/stable/usage/dynamics/k-matrix.html#non-relativistic-k-matrix)\n for an arbitrary number of poles and channels\n - [Symbolic _P_-vector](https://ampform.readthedocs.io/en/stable/usage/dynamics/k-matrix.html#p-vector)\n for an arbitrary number of poles and channels\n\n## Contribute\n\nSee [`CONTRIBUTING.md`](./CONTRIBUTING.md)\n",
"bugtrack_url": null,
"license": "GPLv3 or later",
"summary": "Automatically generate symbolic amplitude models for Partial Wave Analysis",
"version": "0.15.3",
"project_urls": {
"Changelog": "https://github.com/ComPWA/ampform/releases",
"Documentation": "https://ampform.rtfd.io",
"Source": "https://github.com/ComPWA/ampform",
"Tracker": "https://github.com/ComPWA/ampform/issues"
},
"split_keywords": [
"hep",
" pwa",
" amplitude analysis",
" partial wave analysis",
" particle physics",
" particles",
" physics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0e06516e9f552087e53dc285947bc0e8ec6f0f23640f9a1383169cc506ee2444",
"md5": "8d82f0a1a127814671263146fd9a7890",
"sha256": "d9ed329343f7c2d9782e213b9c1d3b327a1ac1cd6d7537698a8151d2c505af7d"
},
"downloads": -1,
"filename": "ampform-0.15.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d82f0a1a127814671263146fd9a7890",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 91682,
"upload_time": "2024-05-21T16:50:05",
"upload_time_iso_8601": "2024-05-21T16:50:05.318131Z",
"url": "https://files.pythonhosted.org/packages/0e/06/516e9f552087e53dc285947bc0e8ec6f0f23640f9a1383169cc506ee2444/ampform-0.15.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "875bbad0dfe0fc7088f29304359e0394b686d28c17bf12d8968ecfd363c22bb4",
"md5": "f805f98b1997f2cd815e7d6cf1208c0c",
"sha256": "835dba0b225e5dbed687357361cf48dde73d2aad392c9aaada2e146b1cb03897"
},
"downloads": -1,
"filename": "ampform-0.15.3.tar.gz",
"has_sig": false,
"md5_digest": "f805f98b1997f2cd815e7d6cf1208c0c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 185925,
"upload_time": "2024-05-21T16:50:07",
"upload_time_iso_8601": "2024-05-21T16:50:07.623382Z",
"url": "https://files.pythonhosted.org/packages/87/5b/bad0dfe0fc7088f29304359e0394b686d28c17bf12d8968ecfd363c22bb4/ampform-0.15.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-21 16:50:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ComPWA",
"github_project": "ampform",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ampform"
}
JSON
