IAP GITLAB

README.md 3.03 KB
Newer Older
Ralf Ulrich's avatar
Ralf Ulrich committed
1 2 3 4 5
# CORSIKA8 Framework for Particle Cascades in Astroparticle Physics**

Documentation and reference guide for the CORSIKA8 software framework
for air shower simulations. We aim that CORSIKA remains the most comprehensive
framework for simulating particle cascades with stochastic and continuous processes. The purpose of CORSIKA is to 
6
simulate any particle cascades in astroparticle physics or astrophysical context. A lot of emphasis is put on modularity, flexibility, completeness, validation and correctness. To boost computational efficiency different techniques are
Ralf Ulrich's avatar
Ralf Ulrich committed
7 8 9 10 11 12 13 14 15 16
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 run time
only specific model parameters can still be changed.

CORSIKA8 is released under the GPL3 license. See [license file](https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/blob/master/LICENSE) which is part of every release and the source code. 

When you contribute to CORSIKA check the guidelines outlined here:
17
[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 CORSIKA project and you should include yourself in the [AUTHORS](https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/blob/master/AUTHORS) file. 
Ralf Ulrich's avatar
Ralf Ulrich committed
18

19
IMPORTANT: Before your contribute, you need to read and agree to the [collaboration agreement](https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/blob/master/COLLABORATION_AGREEMENT.md). The agreement can be discussed, and eventually improved. 
Ralf Ulrich's avatar
Ralf Ulrich committed
20 21 22 23 24

We also want to point you to the [MCnet guidelines](https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/blob/master/MCNET_GUIDELINES), which are very useful also for us. 

## Installation

Hans Dembinski's avatar
Hans Dembinski committed
25
Prerequisites: eigen3, boost, cmake, g++, git. On Ubuntu 18.04, just do:
Ralf Ulrich's avatar
Ralf Ulrich committed
26
```
Hans Dembinski's avatar
Hans Dembinski committed
27
sudo apt-get install libeigen3-dev libboost-dev cmake g++ git
Ralf Ulrich's avatar
Ralf Ulrich committed
28 29
```

30
Follow these steps to download and install CORSIKA8-milestone2
Ralf Ulrich's avatar
Ralf Ulrich committed
31 32 33
```
git clone git@gitlab.ikp.kit.edu:AirShowerPhysics/corsika.git
cd corsika
34
git checkout milestone2
Ralf Ulrich's avatar
Ralf Ulrich committed
35 36 37 38 39 40 41
mkdir ../corsika-build
cd ../corsika-build
cmake ../corsika -DCMAKE_INSTALL_PREFIX=../corsika-install
make -j8
make install
make test
```
42 43 44 45 46 47 48 49 50 51 52 53 54
and if you want to see how the first simple hadron cascade develops, see `Documentation/Examples/cascade_example.cc` for a starting point. 

Run the cascade_example with: 
```
cd ../corsika-install
share/examples/cascade_example
```

Visualize output: 
```
bash share/tools/plot_tracks.sh tracks.dat 
firefox tracks.dat.gif 
```
Hans Dembinski's avatar
Hans Dembinski committed
55 56 57 58 59 60 61 62 63 64 65

### Generating doxygen documentation

To generate the documentation, you need doxygen and graphviz. On Ubuntu 18.04, do:
```
sudo apt-get install doxygen graphviz
```
Switch to the corsika build directory and do
```
make doxygen
```
66 67 68 69
browse with firefox:
```
firefox ../corsika-install/share/doc/html/index.html
```