Welcome to pygama’s documentation!

pygama is a Python package for:

• 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

Start with the package overview for a high-level description of pygama’s data tiers and main sub-packages. Then dive into the module guides for detailed documentation of each sub-package:

• Hit-tier production — pygama.hit — hit-tier production from DSP parameters

• Event building — pygama.evt — TCM and event-tier building

• Mathematical utilities — pygama.math — statistical distributions and fitting utilities

• Parameter generation — pygama.pargen — detector calibration and parameter generation

Documentation

• Package overview

• Module guides
  • Hit-tier production — pygama.hit
  • Event building — pygama.evt
  • Mathematical utilities — pygama.math
  • Parameter generation — pygama.pargen

• Package API reference

• Tutorials (Jupyter notebooks)

Related projects

• LEGEND Data Objects
• Decoding Digitizer Data
• Digital Signal Processing

Development

• Source Code
• License
• Citation
• Changelog
• Developer’s guide