umami-hep / umami

Mirror of the gitlab umami project
Apache License 2.0
1 stars 0 forks source link

pipeline status coverage report Code style: black

Umami

The Umami documentation is avaliable here:

Umami docs

Below is included a brief summary on how to get started fast.

Installation

You can find the detailed described in the umami docs.

Testing & Linter

To better collaborate on this project, we require some code practices such as:

More details can be found here.

Preprocessing

For the training of umami the ntuples are used as specified in the section MC Samples.

The ntuples need to be preprocessed following the Preprocessing Instructions.

Training

If you want to train or evaluate DL1r or DIPS please follow the Training Instructions.

Tutorial for Umami

At the FTAG Workshop in 2022 in Amsterdam, we gave a tutorial how to work with Umami. You can find the slides together with a recording of the talk here. The corresponding step-by-step tutorial can be found in the FTAG docs webpage here.