Readme update

This commit is contained in:
Alexander Nozik 2020-11-14 18:25:53 +03:00
parent 656f16af70
commit fb84596b4c

View File

@ -1,5 +1,25 @@
## Trapping simulation ## 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 ## Building executable
1. Create a fat jar distribution: 1. Create a fat jar distribution: