Skip to content

About

LEGEND Julia Dataflow scripts for data processing

Topics

Resources

Stars

4 stars

Watchers

2 watching

Forks

Repository files navigation

JuLeAna

Documentation for stable version Documentation for development version Version License Build Status Codecov Aqua QA

JuLeAna is the Julia dataflow of the LEGEND-200 analysis. It processes LEGEND-200 data from the raw tier up to the event level, on a single machine or on a SLURM cluster:

  • parallel processing with ParallelProcessingTools, which connects local or SLURM worker processes to a running julia session;
  • run- and partition-level processors, ordered by rank and dependencies;
  • a Markdown report for every processing step, monitoring and analysis plots, and parameter files with validity entries.

Installation

JuLeAna and the other LEGEND packages are registered in the LegendJuliaRegistry:

import Pkg
Pkg.Registry.add("General")
Pkg.Registry.add(url = "https://github.com/legend-exp/LegendJuliaRegistry.git")

To run the dataflow, install JuLeAna as a Julia app, which creates the juleana command (add ~/.julia/bin to the PATH):

import Pkg
Pkg.Apps.add("JuLeAna")                            # or Pkg.Apps.develop(path = "path/to/JuLeAna.jl")

Quick start

juleana                                    # terminal user interface, config of the data production
juleana -c config/processing_config.yaml   # a given processing config
juleana --no-tui                           # run all enabled processors without the interface
juleana --new-production                   # create a new data production
juleana --help                             # command line options

config/ contains example processing configs, and setup/ contains a script to set the permissions of a production.

Documentation

The documentation describes the concepts, the command line options and the terminal user interface, running on a cluster, the processing config, every processor, and the API (development version).

About

LEGEND Julia Dataflow scripts for data processing

Topics

Resources

Stars

4 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages