IAP GITLAB

Skip to content
Snippets Groups Projects

Usage and collaboration agreement

The CORSIKA 8 project very much welcomes all collaboration and contributions. The aim of the project is to create a scientific software framework as a fundamental tool for research.

The project consists of the contributions from the scientific community and individuals in a best effort to deliver the best possible performance and physics output.

The software license of the CORSIKA project

CORSIKA 8 is by default released under the BSD 3-Clause License, as copied in full in the file LICENSE. Each source file of the CORSIKA project contains a short statement of the copyright and this license. Each binary or source code release of CORSIKA contains the file LICENSE.

The code, documentation and content in the folder ./externals is not integral part of the CORSIKA project and can be based on, or include, other licenses, which must be compatible with the CORSIKA 8 license.

The folder ./modules contains the code of several external physics models for your convenience. They each come with their own license which we ask you to honor. Please also make sure to cite the adequate reference papers when using their models in scientific work and publications.

Of course, we have the authors' consent to distribute their code together with CORSIKA 8.

Check the content of these folders carefully for details and additional license information. It depends on the configuration of the build system to what extent this code is used to build CORSIKA.

Contributing

If you want to contribute, you need to read the contributing GUIDELINES and comply with these rules, or help to improve them.

General guidelines

We reproduce below some guidelines copied from http://www.montecarlonet.org/ that we also ask you to follow in the spirit of academic collaboration.

  1. The integrity of the program should be respected.

1.1) Suspected bugs and proposed fixes should be reported back to the original authors to be considered for inclusion in the standard distribution. No independently developed and maintained forks should be created as long as the original authors actively work on the program.

1.2) The program should normally be redistributed in its entirety. When there are special reasons, an agreement should be sought with the original authors to redistribute only specific parts. This should be arranged such that the redistributed parts remain updated in step with the standard distribution.

1.3) Any changes in the code must be clearly marked in the source (reason, author, date) and documented. If any modified version is redistributed it should be stated at the point of distribution (download link) that it has been modified and why.

1.4) If a significant part of the code is used by another program, this should be clearly specified in that program's documentation and stated at its point of distribution.

1.5) Copyright information and references may not be removed. Copyright-related program messages may not be altered and must be printed even if only a part of the program is used. Adding further messages specifying any modifications is encouraged.

  1. The program and its physics should be properly cited when used for academic publications

2.1) The main software reference as designated by the program authors should always be cited.

2.2) In addition, the original literature on which the program is based should be cited to the extent that it is of relevance for a study, applying the same threshold criteria as for other literature.

2.3) When several programs are combined, they should all be mentioned, commensurate with their importance for the physics study at hand.

2.4) To make published results reproducible, the exact versions of the codes that were used and any relevant program and parameter modifications should be spelled out.

(These guidelines were originally edited by Nils Lavesson and David Grellscheid for the MCnet collaboration, which has approved and agreed to respect them. MCnet is a Marie Curie Research Training Network funded under Framework Programme 6 contract MRTN-CT-2006-035606.)