legend-dataflow-scripts

legend-dataflow-scripts is a Python package based on Snakemake for running the LEGEND data production pipeline. It calibrates and optimises hundreds of HPGe detector channels in parallel before building the final analysis-ready data tiers. It takes as input the detector metadata from legend-metadata.

Getting started

It is recommended to install the package using uv.

For a quick development install:

uv pip install ".[docs,test]"

Documentation

Documentation

• Package overview
  • Architecture
  • Module Reference
  • Key Dependencies
• CLI entry points
  • Workflow Management
  • Data Tier Building
  • DSP Parameter Optimisation (par-geds-dsp-*)
  • HIT Parameter Optimisation (par-geds-hit-*)
  • Typical Invocation

Package Overview

Architecture, module descriptions, and dependency overview.

CLI Entry Points (Callables)

All command-line tools provided by the package with descriptions and usage examples.

API Reference

API reference

• Package API reference

Development

Development

• Developer guide
  • Snakemake Rules
  • Configuration
  • Adding a New DSP Parameter Script
  • Adding a New HIT Calibration Script
  • Adding a New Detector Type
  • Code Style and Conventions
• Source Code

Developers Guide

How to add new calibration scripts, Snakemake rules, and entry points.

Related Projects

Related projects

• LEGEND Data Objects
• Decoding Digitizer Data
• Digital Signal Processing
• Pygama
• Legend-dataflow