diff --git a/COAST/README.md b/COAST/README.md index 634854a199e9788ad6e5606fe2a53fdbde6522eb..96e62845bd4843c21e97d15e8c4a249c69cec0d6 100644 --- a/COAST/README.md +++ b/COAST/README.md @@ -1,4 +1,4 @@ -# COAST interface {#COASTinterface} +# COAST interface {#COAST} With the COAST interface of CORSIKA 8 you can write a CORSIKA 8 "process" class and link it to CORSIKA 7. This can be very powerful to @@ -6,7 +6,7 @@ benchmark new CORSIKA 8 physics code in the context of "old" CORSIKA 7 simulations. This is based on corsika7/trunk/coast/CoastOptions/example with an -additional interface to CORSIKA 8. +additional interface to CORSIKA 8. See code in namespace corsika::coast for all details. We provide a step-by-step example for a "COAST user library" using CORSIKA 8 technology. It explains the steps, how to use the COAST_USER_LIB diff --git a/Documentation/Doxygen/Doxyfile.in b/Documentation/Doxygen/Doxyfile.in index dacef653aa17b38022d95ab19626356cc67010f0..0cf0cd506c4b9f63021354ab85b63b3329aea6c0 100644 --- a/Documentation/Doxygen/Doxyfile.in +++ b/Documentation/Doxygen/Doxyfile.in @@ -1,12 +1,14 @@ -PROJECT_NAME = CORSIKA -PROJECT_NUMBER = 8.0.0 +PROJECT_NAME = CORSIKA 8 +PROJECT_NUMBER = 0.0.0 + +GENERATE_HTML = YES +GENERATE_LATEX = YES OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/ INPUT = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@/Framework EXCLUDE_PATTERNS = */ThirdParty/*/* - -GENERATE_HTML = YES -GENERATE_LATEX = YES +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ FILE_PATTERNS = *.cc *.cpp *.cxx *.h *.dox *.inc *.md EXTENSION_MAPPING = inc=C++ diff --git a/Framework/Particles/ParticleProperties.h b/Framework/Particles/ParticleProperties.h index fa3922d55c427c2758d4e1477b2bcc927b5c8aab..ad1a14e620899089e94093722c630e218b8db4c2 100644 --- a/Framework/Particles/ParticleProperties.h +++ b/Framework/Particles/ParticleProperties.h @@ -27,7 +27,6 @@ #include <corsika/units/PhysicalUnits.h> /** - * @namespace particle * * The properties of all elementary particles is stored here. The data * is taken from the Pythia ParticleData.xml file. @@ -36,10 +35,13 @@ namespace corsika::particles { + /** + * @enum Code + * The Code enum is the actual place to define CORSIKA 8 particle codes. + */ enum class Code : int16_t; - - using PDGCodeType = int32_t; using CodeIntType = std::underlying_type<Code>::type; + using PDGCodeType = int32_t; // forward declarations to be used in GeneratedParticleProperties int16_t constexpr GetElectricChargeNumber(Code const); diff --git a/Framework/Particles/particles.dox b/Framework/Particles/particles.dox new file mode 100644 index 0000000000000000000000000000000000000000..22a36c59f0a752074c076d1fb0f6450f0dff51dd --- /dev/null +++ b/Framework/Particles/particles.dox @@ -0,0 +1,15 @@ +/** +@page Particles Particle properties + +The properties of all particles are saved in static and flat +arrays. There is a enum corsika::particles::Code to identify each +particles, and each individual particles has its own static class, +which can be used to retrieve its physical properties. + + + +See namespace corsika::particles for all classes. + + + +*/ \ No newline at end of file diff --git a/Framework/StackInterface/Stack.dox b/Framework/StackInterface/Stack.dox index 94aea67432730b83a11c29fe8c7fba54800ecb1e..8ac29c628c08a5c2a65ad8831d762b9b67c830e7 100644 --- a/Framework/StackInterface/Stack.dox +++ b/Framework/StackInterface/Stack.dox @@ -1,5 +1,5 @@ /** - @page stack Description of particle stacks + @page Stack Description of particle stacks In the CORSIKA 8 framework particle data is always stored in particle stacks. A particle is, thus, always a reference (iterator) diff --git a/README.md b/README.md index 7136e641e258c07c473fb1b3cb4b1969dc080535..67dd505f0d4dafc3f5ee73e055df7e4754429c99 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CORSIKA 8 Framework for Particle Cascades in Astroparticle Physics** +# CORSIKA 8 Framework for Particle Cascades in Astroparticle Physics The purpose of CORSIKA is to simulate any particle cascades in astroparticle physics or astrophysical context. A lot of emphasis is @@ -104,3 +104,4 @@ browse with firefox: ``` firefox ../corsika-install/share/doc/html/index.html ``` + diff --git a/corsika.dox b/corsika.dox index b84d0e9e2c815e38fa09cbad1200eb77f1c657b9..bfbb74d79eaaad1a07ba095c6a34c1a205f54678 100644 --- a/corsika.dox +++ b/corsika.dox @@ -1,9 +1,9 @@ /** -@mainpage CORSIKA 8 air shower simulations framework +@mainpage Technical documentation of the CORSIKA 8 software framework -Documentation and reference guide for the CORSIKA8 (CORSIKA version 8) -software framework for air shower simulations. CORSIKA8 is developed +Software documentatin and reference guide for the CORSIKA 8 +software framework for air shower simulations. CORSIKA 8 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 @@ -16,17 +16,12 @@ Write to corsika-devel@lists.kit.edu, or even register yourself at https://www.lists.kit.edu/sympa/info/corsika-devel to get in contact with other developers. -If you use, or want to refer to, CORSIKA8 please cite <a href="https://doi.org/10.1007/s41781-018-0013-0">"Towards a Next -Generation of CORSIKA: A Framework for the Simulation of Particle -Cascades in Astroparticle Physics" [Comput.Softw.Big Sci. 3 (2019) -2]</a>. We kindly ask (and -expect) any relevant improvement or addition to be offered or -contributed to the main CORSIKA8 repository for the benefit of the -whole community. +For more information about the project, see @ref md_README. -For more information, see also the -<a -href="https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/blob/master/README.md">central README.md file</a>. +## Further details: + 1. @subpage Stack + 2. @subpage Particles + 3. @subpage COAST */