From f46b8365b19c402f76e610eb89de6f46a2904673 Mon Sep 17 00:00:00 2001 From: Tamas Gal <himself@tamasgal.com> Date: Thu, 16 May 2024 10:17:21 +0200 Subject: [PATCH] Update readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5409faa..095d4b8 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,20 @@ [](https://git.km3net.de/tgal/LumenManufaktur.jl/pipelines) [](https://git.km3net.de/tgal/LumenManufaktur.jl/commits/main) -Welcome to the `LumenManufaktur.jl` repository! +`LumenManufaktur.jl` is a software package written in Julia with the aim of +providing high-performance routines to calculate probability density functions +of the arrival time of light on PMTs induced by muons and showers including +production (Cherenkov radiation, photons from energy loss of a muon, shower +light), transmission (dispersion, absorption and scattering) and detection +(angular acceptance, quantum efficiency, shadowing) of light with a PMT. + +The software is written in a way that allows the user to plug in their own models for dispersion, absorption, scattering and also for the quantum efficiency and angular acceptance of PMTs. + +The implementation is based on the C++ framework `Jpp` developed by Maarten de +Jong for the KM3NeT neutrino telescope. More details about the underlying +physics and models can be found in ["The probability density function of the +arrival time of Čerenkov light", M. de Jong, E. van Campenhout, arXiv:2305.19626 +[astro-ph.IM]](https://arxiv.org/abs/2305.19626). ## Documentation -- GitLab