From 8a44802e824975b090f1238303cd12f1a76d5ec8 Mon Sep 17 00:00:00 2001 From: ralfulrich <ralf.ulrich@kit.edu> Date: Fri, 7 Sep 2018 12:25:25 +0200 Subject: [PATCH] added some dox --- ThirdParty/ThirdParty.dox | 4 ++++ corsika.dox | 27 ++++++++++++++++++++------- 2 files changed, 24 insertions(+), 7 deletions(-) diff --git a/ThirdParty/ThirdParty.dox b/ThirdParty/ThirdParty.dox index 956b180f..ec0e3de3 100644 --- a/ThirdParty/ThirdParty.dox +++ b/ThirdParty/ThirdParty.dox @@ -25,4 +25,8 @@ The catch2 unit testing library is from: https://github.com/catchorg/Catch2 Licence: BSL-1.0 (https://github.com/martinmoene/PhysUnits-CT-Cpp11/blob/master/LICENSE_1_0.txt) References: https://github.com/catchorg/Catch2 +@section eigen3 + +eigen3 .... + */ diff --git a/corsika.dox b/corsika.dox index cf0e6d39..d48248f7 100644 --- a/corsika.dox +++ b/corsika.dox @@ -1,17 +1,30 @@ /** @mainpage CORSIKA air shower simulations framework -Documentation and reference guide for the CORSIKA8 software framework -for air shower simulations. CORSIKA is the most comprehensive -framework for air shower simulations. CORSIKA is characterized by -simulating particle cascades in astrophysical environments. The impact -of stochastic and continuous processes on the cascade development is -simulated. To boost computational efficiency different techniques are -provided, like thinning or cascade equations. +Documentation and reference guide for the CORSIKA8 (CORSIKA version 8) +software framework for air shower simulations. CORSIKA8 is developed +at <a +href="https://gitlab.ikp.kit.edu/AirShowerPhysics">https://gitlab.ikp.kit.edu</a>. If +you got the code from somewhere else, consider to switch to the +official development repository. If you want to report bugs, or want +to suggest features or future development, please submit an "issue" on +this gitlab server. + +CORSIKA is the most comprehensive framework for simulating particle +cascades in astrophysical environments, for example extensive air +showers. The impact of stochastic and continuous processes on the +cascade development is simulated. To boost computational efficiency +different techniques are provided, like thinning or cascade equations. The software makes extensive use of static design patterns and compiler optimization. Thus, the most fundamental configuration decision of the user must be performed at compile time. At runtime only spcific parameters can still be changed. +When you contribute to CORSIKA, follow the guidlines outlined here: + +<a +href="https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/wikis/home">Development +wiki text</a> + */ -- GitLab