tudo-astroparticlephysics / PROPOSAL

Monte Carlo Simulation propagating charged Leptons through Media as C++ Library
GNU Lesser General Public License v3.0
35 stars 21 forks source link

Improve documentation on Component and Media #321

Open Jean1995 opened 2 years ago

Jean1995 commented 2 years ago

There should be a jupyter notebook which describes how to use custom components and media, and which describes how they work in general.

Furthermore, we should revise the in-code documentation of these classes as well (both variable names and docstrings). Most descriptions have just been carried over from MMC, and I believe that some translations are wrong (or at the very least misleading).