Python for CORSIKA8

Installation

To install the CORSIKA 8 Python library, you will need Python >= 3.6. The below instructions are assuming that python refers to Python 3.*. If python still refers to Python 2.*, please replace python with python3 and pip with pip3.

To install this package, change into the corsika/Python directory and run

pip install --user -e .

You can verify that the installation was successful by trying to import corsika

python -c 'import corsika'

Running the Tests

If you wish to develop new features in corsika, you will also need to install some additional dependencies so you can run our unit tests. These can be installed with

pip install --user -e '.[test]'

Once that is completed, you can run the unit tests directory from the corsika directory

python -m pytest tests

Development Guide

corsika is a type Python package with type-checking using Mypy and all code is formatted with the Black formatter.

All code must pass these checks, as well as several others, before it can be merged into CORSIKA. A Makefile is provided to simplify running these in tasks.

make mypy   # this will run the mypy type checker

make isort  # this will automatically sort `import` statements

make black  # this will automatically format your code

make flake  # this checks that all code passes our linting rules

make tests  # this runs our test suite

Lastly, we provide an all target that runs all of the above in the sequence shown above:

make all  # run all of the above tests