Welcome to pygama’s documentation!#

pygama is a Python package for:

converting physics data acquisition system output to LEGEND LH5-format HDF5 files
performing bulk digital signal processing on time-series data
optimizing those digital signal processing (DSP) routines and tuning associated analysis parameters
generating and selecting high-level event data for further analysis

Getting started#

pygama is published on the Python Package Index. Install on local systems with pip:

Stable release

$ pip install pygama

Unstable (main branch)

$ pip install pygama@git+https://github.com/legend-exp/pygama@main

Linux Containers

Get a LEGEND container with pygama pre-installed on Docker hub or follow instructions on the LEGEND wiki.

If you plan to develop pygama, refer to the developer’s guide.

Attention

If installing in a user directory (typically when invoking pip as a normal user), make sure ~/.local/bin is appended to PATH. The pygama executable is installed there.

Next steps#

Package API reference

Related projects

Development