Draft: Develop Cherenkov emission module
Closes #275
Here is the first official version of cherenkov emission module. 2 versions are available : Cherenkov and CherenkovToolBox.
CherenkovToolBox uses Corsika 7 input to generate photons and ables to compare Corsika 7 Cherenkov module with Corsika 8 Cherenkov module with close algorithms whereas Cherenkov uses Corsika 8 experiments with for the moment close algorithm with some modifications. For this version, the model is Corsika 7 for calculation algorithms.
The 2 modules uses for the moment an Atmosphere Tabulated to propagate photons. A Telescope Grid class generates a grid of telescopes and sort photons by telescope. Some examples are used :
- cascade_example_cherenkov_tabulated_corsika7 : CherenkovToolBox
- em_shower_cherenkov_tabulated (with input file) : Cherenkov with an input file to test different experiments easily in em cascade
You can save with these modules photon positions, directions, arrival time,... And keep photon information by telescope in output screen.
-
The MR is without WIP/Draft
status -
Make sure the most recent CI jobs (config, quality, build_test_example) all run fine with no failures - if "check clang-format" failed: the code contributor has to run
./do-clang-format.py --apply
eventually with the--all
option - if "check copyright" failed the code contributor has to run
./do-copyright.py --add=20xy
- if "check clang-format" failed: the code contributor has to run
-
Make sure also the jobs with MR-label ready for code review
succeed. This includes the optional jobs, in particular 'coverage', 'release-clang-8", "release-u-18.04" and make sure no problems occur. You may have to trigger a pipeline manually to check this. -
Check in the "coverage" job output that the coverage did not decrease. It should always stay, or increase. If it decreased --> ask contributor to add further needed unit tests, and check coverage report. - On the MR page, open the "Open in Web IDE" tool
-
Check if the provided solution solves the Issue, discuss on gitlab -
Check that all changes are actually related to the issue -
There are no debug statements left, not even commented out -
Check all changes for coding rules and guidelines
-
- When all above is done:
- Add MR label "Code Review Finished"
ps: Just changed the branch's name