A language to describe particle decays, and tools to work with them.
Project description
](https://github.com/scikit-hep/decaylanguage/raw/master/images/DecayLanguage.png)
DecayLanguage implements a language to describe and convert particle decays between digital representations, effectively making it possible to interoperate several fitting programs. Particular interest is given to programs dedicated to amplitude analyses.
DecayLanguage provides tools to parse so-called .dec decay files, and manipulate and visualize decay chains.
Installation
Just run the following:
pip install decaylanguage
You can use a virtual environment through pipenv or with --user if you know
what those are. Python 2.7 and 3.4+ are supported.
Dependencies: (click to expand)
Required and compatibility dependencies will be automatically installed by pip.
Required dependencies:
- particle: PDG particle data and identification codes
- Numpy: The numerical library for Python
- pandas: Tabular data in Python
- attrs: DataClasses for Python
- plumbum: Command line tools
- lark-parser: A modern parsing library for Python
Python compatibility:
- six: Compatibility library
- pathlib2 backport if using Python 2.7
- enum34 backport if using Python /< 3.5
- importlib_resources backport if using Python /< 3.7
Recommended dependencies:
Usage
This is a quick user guide. For a full API docs, go here.
DecayLanguage is a set of tools for building and transforming particle
decays. The parts are:
Particles
Particles are a key component when dealing with decays. Refer to the particle package for how to deal with particles and PDG identification codes.
Decay files
Decay .dec files can be parsed simply with
from decaylanguage import DecFileParser
parser = DecFileParser('my-decay-file.dec')
parser.parse()
# Inspect what decays are defined
parser.list_decay_mother_names()
# Print decay modes, etc. ...
A copy of the master DECAY.DEC file used by the LHCb experiment is provided here for convenience.
The DecFileParser class implements a series of methods giving access to all
information stored in decay files: the decays themselves, particle name aliases,
definitions of charge-conjugate particles, variable and Pythia-specific
definitions, etc.
Decay modeling
The most common way to create a decay chain is to read in an AmpGen style syntax from a file or a string. You can use:
from decaylanguage.modeling import AmplitudeChain
lines, parameters, constants, states = AmplitudeChain.read_ampgen(text='''
EventType D0 K- pi+ pi+ pi-
D0[D]{K*(892)bar0{K-,pi+},rho(770)0{pi+,pi-}} 0 1 0.1 0 1 0.1
K(1460)bar-_mass 0 1460 1
K(1460)bar-_width 0 250 1
a(1)(1260)+::Spline::Min 0.18412
a(1)(1260)+::Spline::Max 1.86869
a(1)(1260)+::Spline::N 34
''')
Here, lines will be a list of AmplitudeChain lines (pretty print supported in Jupyter notebooks),
parameters will be a table of parameters (ranged parameters not yet supported),
constants will be a table of constants,
and states will be the list of known states (EventType).
Converters
You can output to a format (currently only GooFit supported, feel free to make a PR to add more). Use a subclass of DecayChain, in this case, GooFitChain. To use the GooFit output, type from the shell:
python -m decaylanguage -G goofit myinput.opts
Acknowledgements
DecayLanguage is free software released under a BSD 3-Clause License. It was originally developed by Henry Schreiner.
Changelog
Version 0.3.0 (2019-06-26)
- Decays modelling:
- Updates to Mint related particle data files.
- Parsing of decay files (aka .dec files):
- Lark parser files added, for
.decdecay files. DecFileParserclass introduced, with documentation and test suite.- Various
.dectest decay files added.
- Lark parser files added, for
- Visualisation of decay chains:
DecayChainViewerclass introduced, with documentation and test suite.
- Universal representation of decay chains:
- First "building block" classes
DaughtersDictandDecayModeintroduced, with documentation and test suite.
- First "building block" classes
- Package dependencies:
- Package made dependent on Scikit-HEP's
Particlepackage. - Redundant code removed.
- Package made dependent on Scikit-HEP's
- Continuous integration:
- CI with Azure pipelines introduced.
- CI with Travis and AppVeyor removed.
- Miscellaneous:
- Demo notebook added, with a launcher for Binder. -Copyright statements added to repository files.
- General clean-up and minor bug fixes.
Version 0.2.0 (2018-08-02)
- First release as part of Scikit-HEP.
- Using new data package with
importlib_resources(orimportlib.resourceson Python 3.7). - Better docs and examples.
- Some method renaming.
- Generalized converter script.
Version 0.1.0 (2018-03-13)
- First release on PyPI.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file decaylanguage-0.3.0.tar.gz.
File metadata
- Download URL: decaylanguage-0.3.0.tar.gz
- Upload date:
- Size: 651.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | eb63492803cf803696f5988feb294d338ae6884adb2716199c423b34f10a2eeb |
|
| MD5 | 187f6655641ba51175343846ee6545bd |
|
| BLAKE2b-256 | 2a35c35b40fb8a9962d2322c99112d80eca4d248c1ebc4ea3af35b91b30b2f17 |
File details
Details for the file decaylanguage-0.3.0-py2.py3-none-any.whl.
File metadata
- Download URL: decaylanguage-0.3.0-py2.py3-none-any.whl
- Upload date:
- Size: 209.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | db83274c678a969709a2160413d70b2d36ad2c299638ca496c4ff384b058aea5 |
|
| MD5 | d1833bf30f20e242f59569d4b4bed1f0 |
|
| BLAKE2b-256 | 8dc2271197c87e6918ba5c8b9894d31b4ffbc9ebe36f6fb68d81ffb4740c67e1 |
