From fb84596b4c4206b8018ce02c388affbad935b560 Mon Sep 17 00:00:00 2001 From: Alexander Nozik Date: Sat, 14 Nov 2020 18:25:53 +0300 Subject: [PATCH] Readme update --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 3e54b26..3705545 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ ## Trapping simulation +The code for trapping simulation in the [Troitsk nu-mass experiment](http://mass.inr.ru/unu/index_eng.html). + +Some design details are discussed in the [Youtube video](https://youtu.be/gG45wzL3gug). + +## Authors + +* Simulation: Alexander Nozik (INR RAS, MIPT) +* [Initial scattering code](src/scatter/c): Ferenc Glueck and Sebastian Voecking + +## Structure + +* Electron scattering code in [Scatter.kt](src/main/kotlin/ru/inr/mass/trapping/Scatter.kt). +* Simulation code in [Simulator.kt](src/main/kotlin/ru/inr/mass/trapping/Simulator.kt). + +## Dependencies + +The simulation geometry relies on [Commons math](https://commons.apache.org/proper/commons-math/) library. + +Intermediate pictures created with [Plotly.kt](https://zenodo.org/badge/latestdoi/186020000). + ## Building executable 1. Create a fat jar distribution: