Processes/NullModel/testNullModel.cc

-
-/**
- * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
- *
- * See file AUTHORS for a list of contributors.
- *
- * This software is distributed under the terms of the GNU General Public
- * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
- * the license.
- */
-
-#define CATCH_CONFIG_MAIN // This tells Catch to provide a main() - only do this in one
-                          // cpp file
-#include <catch2/catch.hpp>
-
-#include <corsika/units/PhysicalUnits.h>
-
-TEST_CASE("NullModel", "[processes]") {
-
-  SECTION("bla") {}
-
-  SECTION("blubb") {}
-}

Processes/Sibyll/CMakeLists.txt

-
-set (
-  MODEL_SOURCES
-  ParticleConversion.cc
-  )
-
-set (
-  MODEL_HEADERS
-  ParticleConversion.h
-  )
-
-set (
-  MODEL_NAMESPACE
-  corsika/process/sibyll
-  )
-
-add_library (ProcessSibyll STATIC ${MODEL_SOURCES})
-CORSIKA_COPY_HEADERS_TO_NAMESPACE (ProcessSibyll ${MODEL_NAMESPACE} ${MODEL_HEADERS})
-
-set_target_properties (
-  ProcessSibyll
-  PROPERTIES
-  VERSION ${PROJECT_VERSION}
-  SOVERSION 1
-#  PUBLIC_HEADER "${MODEL_HEADERS}"
-  )
-
-# target dependencies on other libraries (also the header onlys)
-target_link_libraries (
-  ProcessSibyll
-  CORSIKAunits
-  )
-
-target_include_directories (
-  ProcessSibyll 
-  INTERFACE 
-  $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include>
-  $<INSTALL_INTERFACE:include/include>
-  )
-
-install (
-  TARGETS ProcessSibyll
-  LIBRARY DESTINATION lib
-  ARCHIVE DESTINATION lib
-#  PUBLIC_HEADER DESTINATION include/${MODEL_NAMESPACE}
-  )
-
-
-# --------------------
-# code unit testing
-add_executable (testSibyll testSibyll.cc)
-
-target_link_libraries (
-  testSibyll
-  CORSIKAgeometry
-  CORSIKAunits
-  CORSIKAthirdparty # for catch2
-  )
-
-add_test (NAME testSibyll COMMAND testSibyll)
-

Processes/Sibyll/ParticleConversion.cc

-
-/**
- * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
- *
- * See file AUTHORS for a list of contributors.
- *
- * This software is distributed under the terms of the GNU General Public
- * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
- * the license.
- */
-
-#include <corsika/particles/ParticleProperties.h>
-#include <corsika/process/sibyll/ParticleConversion.h>
-
-using namespace corsika::process::sibyll;
-
-// const std::map<sibyll::PID, ParticleProperties::InternalParticleCode>
-//   process::sibyll::Sibyll2Corsika = {
-//        {PID::E_MINUS, InternalParticleCode::Electron},
-//};

Processes/Sibyll/ParticleConversion.h

-
-/**
- * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
- *
- * See file AUTHORS for a list of contributors.
- *
- * This software is distributed under the terms of the GNU General Public
- * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
- * the license.
- */
-
-#ifndef _include_processes_sibyll_particles_h_
-#define _include_processes_sibyll_particles_h_
-
-#include <corsika/particles/ParticleProperties.h>
-
-#include <map>
-
-namespace corsika::process {
-
-  namespace sibyll {
-
-    enum class PID : int {
-      E_MINUS = 3,
-      E_PLUS = 2,
-      NU_E = 15,
-      NU_E_BAR = 16,
-      MU_MINUS = 5,
-      MU_PLUS = 4,
-      NU_MU = 17,
-      NU_MU_BAR = 18,
-      TAU_MINUS = 91,
-      TAU_PLUS = 90,
-      NU_TAU = 92,
-      NU_TAU_BAR = 93,
-      GAMMA = 1,
-      PI_0 = 6,
-      RHO_0 = 27,
-      K_L_0 = 11,
-      PI_PLUS = 7,
-      PI_MINUS = 8,
-      RHO_PLUS = 25,
-      RHO_MINUS = 26,
-      ETA = 23,
-      OMEGA = 32,
-      K_S_0 = 12,
-      K_STAR_0 = 30,
-      K_STAR_BAR_0 = 31,
-      K_PLUS = 9,
-      K_MINUS = 10,
-      K_STAR_PLUS = 28,
-      K_STAR_MINUS = 29,
-      D_PLUS = 59,
-      D_MINUS = 60,
-      D_STAR_PLUS = 78,
-      D_STAR_MINUS = 79,
-      D_0 = 71,
-      D_BAR_0 = 72,
-      D_STAR_0 = 80,
-      D_STAR_BAR_0 = 81,
-      D_S_PLUS = 74,
-      D_S_MINUS = 75,
-      D_STAR_S_PLUS = 76,
-      D_STAR_S_MINUS = 77,
-      ETA_C = 73,
-      N_0 = 14,
-      N_BAR_0 = -14,
-      DELTA_0 = 42,
-      DELTA_BAR_0 = -42,
-      P_PLUS = 13,
-      P_BAR_MINUS = -13,
-      DELTA_PLUS = 41,
-      DELTA_BAR_MINUS = -41,
-      DELTA_PLUS_PLUS = 40,
-      DELTA_BAR_MINUS_MINUS = -40,
-      SIGMA_MINUS = 36,
-      SIGMA_BAR_PLUS = -36,
-      LAMBDA_0 = 39,
-      LAMBDA_BAR_0 = -39,
-      SIGMA_0 = 35,
-      SIGMA_BAR_0 = -35,
-      SIGMA_PLUS = 34,
-      SIGMA_BAR_MINUS = -34,
-      XI_MINUS = 38,
-      XI_BAR_PLUS = -38,
-      XI_0 = 37,
-      XI_BAR_0 = -37,
-      OMEGA_MINUS = 49,
-      OMEGA_BAR_PLUS = -49,
-      SIGMA_C_0 = 86,
-      SIGMA_C_BAR_0 = -86,
-      SIGMA_STAR_C_0 = 96,
-      SIGMA_STAR_C_BAR_0 = -96,
-      LAMBDA_C_PLUS = 89,
-      LAMBDA_C_BAR_MINUS = -89,
-      XI_C_0 = 88,
-      XI_C_BAR_0 = -88,
-      SIGMA_C_PLUS = 85,
-      SIGMA_C_BAR_MINUS = -85,
-      SIGMA_STAR_C_PLUS = 95,
-      SIGMA_STAR_C_BAR_MINUS = -95,
-      SIGMA_C_PLUS_PLUS = 84,
-      SIGMA_C_BAR_MINUS_MINUS = -84,
-      SIGMA_STAR_C_PLUS_PLUS = 94,
-      SIGMA_STAR_C_BAR_MINUS_MINUS = -94,
-      XI_C_PLUS = 87,
-      XI_C_BAR_MINUS = -87,
-      OMEGA_C_0 = 99,
-      OMEGA_C_BAR_0 = -99,
-      J_PSI = 83,
-      VOID = 0,
-    };
-
-    static const std::map<sibyll::PID, corsika::particles::Code> Sibyll2Corsika = {
-        {PID::E_MINUS, corsika::particles::Code::Electron},
-        {PID::E_PLUS, corsika::particles::Code::Positron},
-        {PID::NU_E, corsika::particles::Code::NuE},
-        {PID::NU_E_BAR, corsika::particles::Code::NuEBar},
-        {PID::MU_MINUS, corsika::particles::Code::MuMinus},
-        {PID::MU_PLUS, corsika::particles::Code::MuPlus},
-        {PID::NU_MU, corsika::particles::Code::NuMu},
-        {PID::NU_MU_BAR, corsika::particles::Code::NuMuBar},
-        {PID::TAU_MINUS, corsika::particles::Code::TauMinus},
-        /*
-      TAU_PLUS = 90,
-      NU_TAU = 92,
-      NU_TAU_BAR = 93,
-      GAMMA = 1,
-      PI_0 = 6,
-      RHO_0 = 27,
-      K_L_0 = 11,
-      PI_PLUS = 7,
-      PI_MINUS = 8,
-      RHO_PLUS = 25,
-      RHO_MINUS = 26,
-      ETA = 23,
-      OMEGA = 32,
-      K_S_0 = 12,
-      K_STAR_0 = 30,
-      K_STAR_BAR_0 = 31,
-      K_PLUS = 9,
-      K_MINUS = 10,
-      K_STAR_PLUS = 28,
-      K_STAR_MINUS = 29,
-      D_PLUS = 59,
-      D_MINUS = 60,
-      D_STAR_PLUS = 78,
-      D_STAR_MINUS = 79,
-      D_0 = 71,
-      D_BAR_0 = 72,
-      D_STAR_0 = 80,
-      D_STAR_BAR_0 = 81,
-      D_S_PLUS = 74,
-      D_S_MINUS = 75,
-      D_STAR_S_PLUS = 76,
-      D_STAR_S_MINUS = 77,
-      ETA_C = 73,
-      N_0 = 14,
-      N_BAR_0 = -14,
-      DELTA_0 = 42,
-      DELTA_BAR_0 = -42,
-      P_PLUS = 13,
-      P_BAR_MINUS = -13,
-      DELTA_PLUS = 41,
-      DELTA_BAR_MINUS = -41,
-      DELTA_PLUS_PLUS = 40,
-      DELTA_BAR_MINUS_MINUS = -40,
-      SIGMA_MINUS = 36,
-      SIGMA_BAR_PLUS = -36,
-      LAMBDA_0 = 39,
-      LAMBDA_BAR_0 = -39,
-      SIGMA_0 = 35,
-      SIGMA_BAR_0 = -35,
-      SIGMA_PLUS = 34,
-      SIGMA_BAR_MINUS = -34,
-      XI_MINUS = 38,
-      XI_BAR_PLUS = -38,
-      XI_0 = 37,
-      XI_BAR_0 = -37,
-      OMEGA_MINUS = 49,
-      OMEGA_BAR_PLUS = -49,
-      SIGMA_C_0 = 86,
-      SIGMA_C_BAR_0 = -86,
-      SIGMA_STAR_C_0 = 96,
-      SIGMA_STAR_C_BAR_0 = -96,
-      LAMBDA_C_PLUS = 89,
-      LAMBDA_C_BAR_MINUS = -89,
-      XI_C_0 = 88,
-      XI_C_BAR_0 = -88,
-      SIGMA_C_PLUS = 85,
-      SIGMA_C_BAR_MINUS = -85,
-      SIGMA_STAR_C_PLUS = 95,
-      SIGMA_STAR_C_BAR_MINUS = -95,
-      SIGMA_C_PLUS_PLUS = 84,
-      SIGMA_C_BAR_MINUS_MINUS = -84,
-      SIGMA_STAR_C_PLUS_PLUS = 94,
-      SIGMA_STAR_C_BAR_MINUS_MINUS = -94,
-      XI_C_PLUS = 87,
-      XI_C_BAR_MINUS = -87,
-      OMEGA_C_0 = 99,
-      OMEGA_C_BAR_0 = -99,
-      J_PSI = 83,
-      VOID = 0,*/
-    };
-
-  } // namespace sibyll
-
-} // namespace corsika::process
-
-#endif

Processes/Sibyll/sibyll_codes.dat

-E_MINUS 3
-E_PLUS 2
-NU_E 15
-NU_E_BAR 16
-MU_MINUS 5
-MU_PLUS 4
-NU_MU 17
-NU_MU_BAR 18
-TAU_MINUS 91
-TAU_PLUS 90
-NU_TAU 92
-NU_TAU_BAR 93
-GAMMA 1
-PI_0 6
-RHO_0 27
-K_L_0 11
-PI_PLUS 7
-PI_MINUS 8
-RHO_PLUS 25
-RHO_MINUS 26
-ETA 23
-OMEGA 32
-K_S_0 12
-K_STAR_0 30
-K_STAR_BAR_0 31
-K_PLUS 9
-K_MINUS 10
-K_STAR_PLUS 28
-K_STAR_MINUS 29
-D_PLUS 59
-D_MINUS 60
-D_STAR_PLUS 78
-D_STAR_MINUS 79
-D_0 71
-D_BAR_0 72
-D_STAR_0 80
-D_STAR_BAR_0 81
-D_S_PLUS 74
-D_S_MINUS 75
-D_STAR_S_PLUS 76
-D_STAR_S_MINUS 77
-ETA_C 73
-N_0 14
-N_BAR_0 -14
-DELTA_0 42
-DELTA_BAR_0 -42
-P_PLUS 13
-P_BAR_MINUS -13
-DELTA_PLUS 41
-DELTA_BAR_MINUS -41
-DELTA_PLUS_PLUS 40
-DELTA_BAR_MINUS_MINUS -40
-SIGMA_MINUS 36
-SIGMA_BAR_PLUS -36
-LAMBDA_0 39
-LAMBDA_BAR_0 -39
-SIGMA_0 35
-SIGMA_BAR_0 -35
-SIGMA_PLUS 34
-SIGMA_BAR_MINUS -34
-XI_MINUS 38
-XI_BAR_PLUS -38
-XI_0 37
-XI_BAR_0 -37
-OMEGA_MINUS 49
-OMEGA_BAR_PLUS -49
-SIGMA_C_0 86
-SIGMA_C_BAR_0 -86
-SIGMA_STAR_C_0 96
-SIGMA_STAR_C_BAR_0 -96
-LAMBDA_C_PLUS 89
-LAMBDA_C_BAR_MINUS -89
-XI_C_0 88
-XI_C_BAR_0 -88
-SIGMA_C_PLUS 85
-SIGMA_C_BAR_MINUS -85
-SIGMA_STAR_C_PLUS 95
-SIGMA_STAR_C_BAR_MINUS -95
-SIGMA_C_PLUS_PLUS 84
-SIGMA_C_BAR_MINUS_MINUS -84
-SIGMA_STAR_C_PLUS_PLUS 94
-SIGMA_STAR_C_BAR_MINUS_MINUS -94
-XI_C_PLUS 87
-XI_C_BAR_MINUS -87
-OMEGA_C_0 99
-OMEGA_C_BAR_0 -99
-J_PSI 83
-VOID 0

Processes/Sibyll/testSibyll.cc

-
-/**
- * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
- *
- * See file AUTHORS for a list of contributors.
- *
- * This software is distributed under the terms of the GNU General Public
- * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
- * the license.
- */
-
-#include <corsika/particles/ParticleProperties.h>
-#include <corsika/process/sibyll/ParticleConversion.h>
-#include <corsika/units/PhysicalUnits.h>
-
-#define CATCH_CONFIG_MAIN // This tells Catch to provide a main() - only do this in one
-                          // cpp file
-#include <catch2/catch.hpp>
-
-using namespace corsika;
-
-TEST_CASE("Sibyll", "[processes]") {
-
-  SECTION("ParticleConversion") {
-    REQUIRE(corsika::particles::Electron::GetCode() ==
-            process::sibyll::Sibyll2Corsika.at(process::sibyll::PID::E_MINUS));
-  }
-
-  SECTION("Data") {
-    REQUIRE(corsika::particles::GetName(process::sibyll::Sibyll2Corsika.at(
-                process::sibyll::PID::E_PLUS)) == "e+");
-  }
-
-  SECTION("bla") {}
-
-  SECTION("blubb") {}
-}

Processes/StackInspector/CMakeLists.txt

-
-set (
-  MODEL_SOURCES
-  StackInspector.cc
-  )
-
-set (
-  MODEL_HEADERS
-  StackInspector.h
-  )
-
-set (
-  MODEL_NAMESPACE
-  corsika/process/stack_inspector
-  )
-
-add_library (ProcessStackInspector STATIC ${MODEL_SOURCES})
-CORSIKA_COPY_HEADERS_TO_NAMESPACE (ProcessStackInspector ${MODEL_NAMESPACE} ${MODEL_HEADERS})
-
-set_target_properties (
-  ProcessStackInspector
-  PROPERTIES
-  VERSION ${PROJECT_VERSION}
-  SOVERSION 1
-#  PUBLIC_HEADER "${MODEL_HEADERS}"
-  )
-
-# target dependencies on other libraries (also the header onlys)
-target_link_libraries (
-  ProcessStackInspector
-  CORSIKAunits
-  CORSIKAsetup
-  )
-
-target_include_directories (
-  ProcessStackInspector 
-  INTERFACE 
-  $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include>
-  $<INSTALL_INTERFACE:include/include>
-  )
-
-install (
-  TARGETS ProcessStackInspector
-  LIBRARY DESTINATION lib
-  ARCHIVE DESTINATION lib
-#  PUBLIC_HEADER DESTINATION include/${MODEL_NAMESPACE}
-  )
-
-
-# --------------------
-# code unit testing
-add_executable (testStackInspector testStackInspector.cc)
-
-target_link_libraries (
-  testStackInspector
-  CORSIKAunits
-  CORSIKAthirdparty # for catch2
-  )
-
-add_test (NAME testStackInspector COMMAND testStackInspector)
-

Processes/StackInspector/StackInspector.cc

-
-/**
-  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
-  * 
-  * See file AUTHORS for a list of contributors.
-  * 
-  * This software is distributed under the terms of the GNU General Public
-  * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
-  * the license.
-*/
-
-#include <corsika/process/stack_inspector/StackInspector.h>
-#include <corsika/units/PhysicalUnits.h>
-
-#include <iostream>
-using namespace std;
-
-using namespace corsika;
-using namespace corsika::units::si;
-using namespace corsika::process::stack_inspector;
-
-template <typename Stack, typename Trajectory>
-StackInspector<Stack, Trajectory>::StackInspector(const bool aReport)
-    : fReport(aReport) {}
-
-template <typename Stack, typename Trajectory>
-StackInspector<Stack, Trajectory>::~StackInspector() {}
-
-template <typename Stack, typename Trajectory>
-process::EProcessReturn StackInspector<Stack, Trajectory>::DoContinuous(Particle&,
-                                                                        Trajectory&,
-                                                                        Stack& s) const {
-
-  // using namespace corsika::particles::io;
-
-  static int countStep = 0;
-  if (!fReport) return EProcessReturn::eOk;
-  // std::cout << "generation  " << countStep << std::endl;
-  [[maybe_unused]] int i = 0;
-  EnergyType Etot = 0_GeV;
-  for (auto& iterP : s) {
-    EnergyType E = iterP.GetEnergy();
-    Etot += E;
-    // std::cout << " particle data: " << i++ << ", id=" << iterP << " | " << std::endl;
-  }
-  countStep++;
-  // cout << "#=" << countStep << " " << s.GetSize() << " " << Etot/1_GeV << endl;
-  cout << countStep << " " << s.GetSize() << " " << Etot / 1_GeV << " " << endl;
-  return EProcessReturn::eOk;
-}
-
-template <typename Stack, typename Trajectory>
-double StackInspector<Stack, Trajectory>::MinStepLength(Particle&) const {
-  return 0;
-}
-
-template <typename Stack, typename Trajectory>
-void StackInspector<Stack, Trajectory>::DoDiscrete(Particle&, Stack&) const {}
-
-template <typename Stack, typename Trajectory>
-void StackInspector<Stack, Trajectory>::Init() {}
-
-#include <corsika/setup/SetupStack.h>
-#include <corsika/setup/SetupTrajectory.h>
-
-template class corsika::process::stack_inspector::StackInspector<setup::Stack,
-                                                                 setup::Trajectory>;

Processes/StackInspector/StackInspector.h

-
-/**
-  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
-  * 
-  * See file AUTHORS for a list of contributors.
-  * 
-  * This software is distributed under the terms of the GNU General Public
-  * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
-  * the license.
-*/
-
-#ifndef _Physics_StackInspector_StackInspector_h_
-#define _Physics_StackInspector_StackInspector_h_
-
-#include <corsika/process/ContinuousProcess.h>
-
-namespace corsika::process {
-
-  namespace stack_inspector {
-
-    template <typename Stack, typename Trajectory>
-    class StackInspector
-        : public corsika::process::ContinuousProcess<StackInspector<Stack, Trajectory>> {
-
-      typedef typename Stack::ParticleType Particle;
-
-    public:
-      StackInspector(const bool aReport);
-      ~StackInspector();
-
-      void Init();
-
-      // template <typename Particle, typename Trajectory, typename Stack>
-      EProcessReturn DoContinuous(Particle&, Trajectory&, Stack& s) const;
-
-      // template <typename Particle>
-      double MinStepLength(Particle&) const;
-
-      // template <typename Particle, typename Stack>
-      void DoDiscrete(Particle&, Stack&) const;
-
-    private:
-      bool fReport;
-    };
-
-  } // namespace stack_inspector
-
-} // namespace corsika::process
-
-#endif

Processes/StackInspector/testStackInspector.cc

-
-/**
-  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
-  * 
-  * See file AUTHORS for a list of contributors.
-  * 
-  * This software is distributed under the terms of the GNU General Public
-  * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
-  * the license.
-*/
-
-#define CATCH_CONFIG_MAIN // This tells Catch to provide a main() - only do this in one
-                          // cpp file
-#include <catch2/catch.hpp>
-
-#include <corsika/units/PhysicalUnits.h>
-
-TEST_CASE("NullModel", "[processes]") {
-
-  SECTION("bla") {}
-
-  SECTION("blubb") {}
-}

README.md

+# CORSIKA 8 Framework for Particle Cascades in Astroparticle Physics
+
+The purpose of CORSIKA 8 is to simulate any particle cascades in
+astroparticle physics or astrophysical context. A lot of emphasis has been
+put on modularity, flexibility, completeness, validation and
+correctness. To boost computational efficiency, different techniques
+are provided, like thinning or cascade equations. The aim is that
+CORSIKA 8 remains the most comprehensive framework for simulating
+particle cascades with stochastic and continuous processes.
+
+The software makes extensive use of static design patterns and
+compiler optimization. Thus, the most fundamental configuration
+decisions of the user must be performed at compile time. At run time,
+model parameters can still be changed.
+
+CORSIKA 8 is by default released under the BSD 3-Clause License. See [license
+file](https://gitlab.iap.kit.edu/AirShowerPhysics/corsika/blob/master/LICENSE)
+which is part of every release and the source code.
+
+If you use, or want to refer to, CORSIKA 8 please cite ["Towards a Next
+Generation of CORSIKA: A Framework for the Simulation of Particle
+Cascades in Astroparticle Physics", Comput. Softw. Big Sci. 3 (2019)
+2](https://doi.org/10.1007/s41781-018-0013-0) as well as
+["Simulating radio emission from particle cascades with CORSIKA 8", Astropart. Phys. 166 (2025)
+103072](https://doi.org/10.1016/j.astropartphys.2024.103072).
+
+We kindly ask (and require) any relevant improvement or addition to be offered or
+contributed to the main CORSIKA 8 repository for the benefit of the
+whole community.
+
+CORSIKA 8 makes use of various third-party code, in particular interaction
+models. Please check the [using and collaborating
+agreement](https://gitlab.iap.kit.edu/AirShowerPhysics/corsika/blob/master/USING_COLLABORATING.md)
+for further information on this topic.
+
+If you plan to contribute to CORSIKA 8, please check the guidelines outlined here:
+[coding
+guidelines](https://gitlab.iap.kit.edu/AirShowerPhysics/corsika/blob/master/CONTRIBUTING.md). Code
+that fails the review by the CORSIKA 8 author group must be improved
+before it can be merged in the official code base. After your code has
+been accepted and merged, you become a contributor of the CORSIKA 8
+project (code author).
+
+IMPORTANT: Before you contribute, you need to read and agree to the conditions set out in the
+[using and collaborating
+agreement](https://gitlab.iap.kit.edu/AirShowerPhysics/corsika/blob/master/USING_COLLABORATING.md).
+The agreement can be discussed, and eventually improved if necessary.
+
+
+## Get in contact
+  * Join our chat threads using Mattermost via this [invite link](https://mattermost.hzdr.de/signup_user_complete/?id=xtdd8jyt6trbiezt71gaz3z4ge&md=link&sbr=su). Click the `GitLab` button, then `Sign in with Helmholtz ID`. You will be able to make an account by either finding your institution, or using your e.g. ORCID, GitHub, or Google account.
+  * Connect to https://gitlab.iap.kit.edu, register yourself and join the "Air Shower Physics" group. Write to us on Mattermost (in the User Questions channel), or directly contact one of the [steering comittee members](https://gitlab.iap.kit.edu/AirShowerPhysics/corsika/-/wikis/Steering-Committee) in case there are problems with that.
+  * Connect to corsika-devel@lists.kit.edu (self-register at
+    https://www.lists.kit.edu/sympa/subscribe/corsika-devel) to get in
+    touch with the project.
+
+
+## Installation
+
+CORSIKA 8 is tested regularly at least on `gcc11.0.0` and `clang-14.0.0`.
+
+### Prerequisites
+
+You will also need:
+
+- Python 3 (supported versions are Python >= 3.6), with pip
+- cmake > 3.4
+- git
+- g++, gfortran, binutils, make
+- optional: FLUKA (see below)
+
+
+On a bare Ubuntu machine, just add:
+``` shell
+sudo apt-get install python3 python3-pip cmake g++ gfortran git doxygen graphviz
+```
+
+### Creating a virtual environment and Conan
+
+It is recommended that you install CORSIKA 8 and its dependencies within a python3 virtual environment.
+To do so, you can run the following.
+``` shell
+# Create the environment using your native python3 binary
+python3 -m venv /path/to/new/virtual/environment/corsika-8
+# Load the environment (should be run each time you open a new terminal)
+source /path/to/new/virtual/environment/corsika-8/bin/activate
+
+```
+
+You will need to load the environment each time that you open a new terminal.
+
+CORSIKA 8 uses the [conan](https://conan.io/) package manager to
+manage our dependencies. Currently, version 2.50.0 or higher is required.
+**Note**: if you are NOT using a virtual environment, you may want to use the `pip install --user` flag.
+
+``` shell
+pip install conan particle==0.25.1 numpy
+```
+
+### Enabling FLUKA support
+
+For legal reasons we do not distribute/bundle FLUKA together with CORSIKA 8.
+As FLUKA is the standard low-energy hadronic interaction model for CORSIKA 8, you have to download
+it separately from (http://www.fluka.org/), which requires registering there as FLUKA user.
+The following should be done *before* compiling CORSIKA 8:
+
+ 1. Note your system's version of gfortran (`gfortran --version`) and glibc (`ldd --version`)
+ 2. Download the FLUKA __binary__, ensuring that it matches the versions you found above
+ 3. Download the FLUKA __data file__ (will be named something similar to __fluka20xy.z-data.tar.gz__).
+ 4. Un-tar the files that you downloaded using `tar -xf <filename>`
+ 5. Set environmental variables `export FLUFOR=gfortran` and `export FLUPRO=<path to where you unzipped the files>`. Note that the `FLUPRO` directory should contain __libflukahp.a__. Both of these variables will have to be set every time you open a new terminal.
+ 6. Go to the `FLUPRO` directory and run `make`. This will compile an exe, __flukahp__, in your current directory.
+ 7. Follow the normal steps to compile CORSIKA 8 (see below).
+
+When you later install CORSIKA 8, you should see a message during the __cmake__ step indicating the FLUKA was correctly found.
+
+``` shell
+libflukahp.a found in directory <some location here> via FLUPRO environment variable
+FLUKA support is enabled.
+```
+
+### Compiling CORSIKA 8
+
+Once Conan is installed and FLUKA provided, follow these steps to download and install CORSIKA 8:
+
+``` shell
+cd ./top/directory/for/corsika/installation
+git clone --recursive git@gitlab.iap.kit.edu:AirShowerPhysics/corsika.git
+# Or for https: git clone --recursive https://gitlab.iap.kit.edu/AirShowerPhysics/corsika.git
+mkdir corsika-build
+cd corsika-build
+../corsika/conan-install.sh --source-directory ../corsika --release-with-debug
+# conan-install.sh takes required options from command line to install dependencies for 'Debug', 'Release' and 'RelWithDebInfo' builds.
+../corsika/corsika-cmake.sh -c "-DCMAKE_BUILD_TYPE="RelWithDebInfo" -DWITH_FLUKA=ON -DCMAKE_INSTALL_PREFIX=../corsika-install"
+make -j4  #The number should match the number of available cores on your machine
+make install
+```
+
+## Alternate installation using docker containers
+
+There are docker containers prepared that bring all the environment and packages you need to run CORSIKA. See [docker hub](https://hub.docker.com/repository/docker/corsika/devel) for a complete overview.
+
+### Prerequisites
+
+You only need docker, e.g. on Ubuntu: `sudo apt-get install docker` and of course root access.
+
+### Compiling
+
+Follow these steps to download and install CORSIKA 8, master development version
+```shell
+cd ./top/directory/for/corsika/installation
+git clone --recursive git@gitlab.iap.kit.edu:AirShowerPhysics/corsika.git
+sudo docker run -v $PWD:/corsika -it corsika/devel:clang-8 /bin/bash
+mkdir corsika-build
+cd corsika-build
+../corsika/conan-install.sh --source-directory ../corsika --release-with-debug
+# conan-install.sh takes required options from command line to install dependencies for 'Debug', 'Release' and 'RelWithDebInfo' builds.
+../corsika/corsika-cmake.sh -c "-DCMAKE_BUILD_TYPE="RelWithDebInfo" -DWITH_FLUKA=ON -DCMAKE_INSTALL_PREFIX=../corsika-install"
+make -j4  #The number should match the number of available cores on your machine
+make install
+```
+
+## Running Unit Tests
+
+To run the unit tests, do the following.
+
+```shell
+cd ./corsika-build
+ctest -j4  #The number should match the number of available cores on your machine
+```
+
+## Running applications and examples
+
+### Standard applications
+
+Applications for standard use-cases are located in the `applications` directory.
+These are example scripts that can be used directly or slightly modified for your use case.
+See [applications/README.md] for more.
+The applications are compiled automatically after running `make` and will appear your `corsika-build/bin` directory.
+After running `make install` the binaries will also be copied into your `corsika-install/bin` directory as well.
+
+
+For example, from inside your `corsika-install/bin` directory, run
+```shell
+c8_air_shower --pdg 2212 -E 1e5 -f my_shower
+```
+This will run a vertical 100 TeV proton shower and will create and put the output into `./my_shower`.
+
+
+### Building the examples
+
+Unlike the applications, the examples must be compiled as a second step.
+From your top corsika directory, (the one that includes `corsika-build` and `corsika-install`) run
+```shell
+export CONAN_DEPENDENCIES=$PWD/corsika-install/lib/cmake/dependencies
+cmake -DCMAKE_TOOLCHAIN_FILE=${CONAN_DEPENDENCIES}/conan_toolchain.cmake -DCMAKE_PREFIX_PATH=${CONAN_DEPENDENCIES} -DCMAKE_POLICY_DEFAULT_CMP0091=NEW -DCMAKE_BUILD_TYPE=RelWithDebInfo -Dcorsika_DIR=$PWD/corsika-build -DWITH_FLUKA=ON -S $PWD/corsika/examples -B $PWD/corsika-build-examples
+cd corsika-build-examples
+make -j4 #The number should match the number of available cores on your machine
+```
+
+You can run the examples by using the binaries in `corsika-build-examples/bin/`.
+For example:
+```shell
+corsika-build-examples/bin/known_particles
+```
+This will print out all of the particles that are known by CORSIKA.
+
+
+### Generating doxygen documentation
+
+To generate the documentation, you need doxygen and graphviz. If you work with
+the docker corsika/devel containers this is already included.
+Otherwise, e.g. on Ubuntu machines, do:
+```shell
+sudo apt-get install doxygen graphviz
+```
+Switch to the `corsika-build` directory and do
+```shell
+make docs
+make install
+```
+open with firefox:
+```shell
+firefox ../corsika-install/share/corsika/doc/html/index.html
+```

SCIENTIFIC_AUTHORS

-(empty...tbd)
-

Setup/CMakeLists.txt

-
-set (
-  SETUP_HEADERS
-  SetupStack.h
-  SetupLogger.h
-  SetupEnvironment.h
-  SetupTrajectory.h
-  )
-
-set (
-  SETUP_NAMESPACE
-  corsika/setup
-  )
-
-add_library (CORSIKAsetup INTERFACE)
-CORSIKA_COPY_HEADERS_TO_NAMESPACE (CORSIKAsetup ${SETUP_NAMESPACE} ${SETUP_HEADERS})
-
-target_link_libraries (
-  CORSIKAsetup
-  INTERFACE
-  CORSIKAgeometry
-  SuperStupidStack
-  )
-
-target_include_directories (
-  CORSIKAsetup
-  INTERFACE 
-  $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include>
-  $<INSTALL_INTERFACE:include/include>
-  )
-
-install (
-  FILES ${SETUP_HEADERS} 
-  DESTINATION include/${SETUP_NAMESPACE}
-  )

Setup/SetupEnvironment.h

-
-/**
-  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
-  * 
-  * See file AUTHORS for a list of contributors.
-  * 
-  * This software is distributed under the terms of the GNU General Public
-  * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
-  * the license.
-*/
-
-#ifndef _include_corsika_setup_environment_h_
-#define _include_corsika_setup_environment_h_
-
-namespace corsika {}
-
-#endif

Setup/SetupLogger.h

-
-/**
-  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
-  * 
-  * See file AUTHORS for a list of contributors.
-  * 
-  * This software is distributed under the terms of the GNU General Public
-  * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
-  * the license.
-*/
-
-#ifndef _include_corsika_setup_logger_h_
-#define _include_corsika_setup_logger_h_
-
-namespace corsika {}
-
-#endif

Setup/SetupStack.h

-
-/**
-  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
-  * 
-  * See file AUTHORS for a list of contributors.
-  * 
-  * This software is distributed under the terms of the GNU General Public
-  * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
-  * the license.
-*/
-
-#ifndef _corsika_setup_setupstack_h_
-#define _corsika_setup_setupstack_h_
-
-#include <corsika/stack/super_stupid/SuperStupidStack.h>
-
-namespace corsika::setup {
-
-  typedef corsika::stack::super_stupid::SuperStupidStack Stack;
-}
-
-#endif

Setup/SetupTrajectory.h

-
-/**
-  * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
-  * 
-  * See file AUTHORS for a list of contributors.
-  * 
-  * This software is distributed under the terms of the GNU General Public
-  * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
-  * the license.
-*/
-
-#ifndef _corsika_setup_setuptrajectory_h_
-#define _corsika_setup_setuptrajectory_h_
-
-#include <corsika/geometry/LineTrajectory.h>
-
-namespace corsika::setup {
-
-  typedef corsika::geometry::LineTrajectory Trajectory;
-}
-
-#endif

Stack/CMakeLists.txt

-
-add_subdirectory (DummyStack)
-add_subdirectory (SuperStupidStack)

Stack/DummyStack/CMakeLists.txt

-
-set (DummyStack_HEADERS DummyStack.h)
-set (DummyStack_NAMESPACE corsika/stack/dummy)
-
-add_library (DummyStack INTERFACE)
-
-CORSIKA_COPY_HEADERS_TO_NAMESPACE (DummyStack ${DummyStack_NAMESPACE} ${DummyStack_HEADERS})
-
-target_link_libraries (
-  DummyStack
-  INTERFACE
-  CORSIKAstackinterface
-  CORSIKAunits
-  CORSIKAparticles
-  )
-
-target_include_directories (
-  DummyStack
-  INTERFACE
-  $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include>
-  $<INSTALL_INTERFACE:include>
-  )
-
-install (
-  FILES
-  ${DummyStack_HEADERS}
-  DESTINATION
-  include/${DummyStack_NAMESPACE}
-  )

Stack/DummyStack/DummyStack.h

-
-/**
- * (c) Copyright 2018 CORSIKA Project, corsika-project@lists.kit.edu
- *
- * See file AUTHORS for a list of contributors.
- *
- * This software is distributed under the terms of the GNU General Public
- * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
- * the license.
- */
-
-#ifndef _include_dummystack_h_
-#define _include_dummystack_h_
-
-#include <corsika/particles/ParticleProperties.h>
-#include <corsika/stack/Stack.h>
-#include <corsika/units/PhysicalUnits.h>
-
-#include <string>
-#include <vector>
-
-namespace corsika::stack {
-
-  namespace dummy {
-
-    /**
-     * Example of a particle object on the stack.
-     */
-
-    template <typename _Stack>
-    class ParticleRead : public StackIteratorInfo<_Stack, ParticleRead<_Stack> > {
-
-      using StackIteratorInfo<_Stack, ParticleRead>::GetIndex;
-      using StackIteratorInfo<_Stack, ParticleRead>::GetStack;
-
-    public:
-    };
-
-    /**
-     *
-     * Memory implementation of the most simple (stupid) particle stack object.
-     */
-
-    class DummyStackImpl {
-
-    public:
-      void Init() {}
-
-      void Clear() {}
-
-      int GetSize() const { return 0; }
-      int GetCapacity() const { return 0; }
-
-      /**
-       *   Function to copy particle at location i2 in stack to i1
-       */
-      void Copy(const int i1, const int i2) {}
-
-    protected:
-      void IncrementSize() {}
-      void DecrementSize() {}
-
-    }; // end class DummyStackImpl
-
-    typedef StackIterator<DummyStackImpl, ParticleRead<DummyStackImpl> > Particle;
-    typedef Stack<DummyStackImpl, Particle> DummyStack;
-
-  } // namespace dummy
-
-} // namespace corsika::stack
-
-#endif