diff --git a/README.md b/README.md index 8f49b1a80856a3fdc6a8056e41848eeadb26b3d4..7136e641e258c07c473fb1b3cb4b1969dc080535 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CORSIKA8 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 @@ -13,26 +13,26 @@ compiler optimization. Thus, the most fundamental configuration decision of the user must be performed at compile time. At run time only specific model parameters can still be changed. -CORSIKA8 is released under the GPL3 license. This does not exclude -that specific CORSIKA8 versions can be released for specific purposes +CORSIKA 8 is released under the GPLv3 license. This does not exclude +that specific CORSIKA 8 versions can be released for specific purposes under different licensing. See [license file](https://gitlab.ikp.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, CORSIKA8 please cite ["Towards a Next +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). 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 +contributed to the main CORSIKA 8 repository for the benefit of the whole community. -When you plan to contribute to CORSIKA8 check the guidelines outlined here: +When you plan to contribute to CORSIKA 8 check the guidelines outlined here: [coding guidelines](https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/blob/master/CONTRIBUTING.md). Code that fails the review by the CORSIKA 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 CORSIKA8 +been accepted and merged you become a contributor of the CORSIKA 8 project and you should include yourself in the [AUTHORS](https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/blob/master/AUTHORS) file. @@ -56,14 +56,14 @@ which are very useful also for us. ## Installation -CORSIKA8 is tested regularly at least on gcc7.3.0 and clang-6.0.0. +CORSIKA 8 is tested regularly at least on gcc7.3.0 and clang-6.0.0. Additional software prerequisites: eigen3, boost, cmake, g++, git. On a bare Ubuntu 18.04, just add: ``` sudo apt-get install libeigen3-dev libboost-dev cmake g++ git ``` -Follow these steps to download and install CORSIKA8-milestone2 +Follow these steps to download and install CORSIKA 8 milestone2 ``` git clone git@gitlab.ikp.kit.edu:AirShowerPhysics/corsika.git cd corsika