CLI Documentation#

panama#

Command line interface for PANAMA, providing useful CORSIKA utilities.

For examples see the PANAMA repository:

The-Ludwig/PANAMA

panama [OPTIONS] COMMAND [ARGS]...

Options

-d, --debug#

Enable debug output

--version#

Show the version and exit.

hdf5#

Convert CORSIKA7 DAT files to hdf5 files.

INPUT: One or more CORSIKA7 datfiles OUTPUT: The filename of the hdf5 output file

For examples see the PANAMA repository:

The-Ludwig/PANAMA

panama hdf5 [OPTIONS] [INPUT]... OUTPUT

Options

-c, --comp <comp>#

Sets a compression level between 0 and 9. 0 means no compression.

-n, --noadd#

Don’t parse Corsika information into additional columns like e.g. pdgid.

-m, --mother#

Parse mother information into additional columns if they are provided with the EHIST option of CORSIKA

-dm, --dropMother#

Drop mother particles that don’t reach observation level. (EHIST)

-dp, --dropNonParticles#

Drop all rows which don’t really represent a particle. (Like decay or additional information)

-d, --debug#

Enable debug output

Arguments

INPUT#

Optional argument(s)

OUTPUT#

Required argument

run#

Run CORSIKA7 in parallel.

The TEMPLATE argument must point to a valid CORSIKA7 steering card, where {run_idx}, {first_event_idx} {n_show} {seed_1} {seed_2} and {dir} will be replaced accordingly.

For examples see the PANAMA repository:

The-Ludwig/PANAMA

panama run [OPTIONS] TEMPLATE

Options

-n, --events <events>#

Number of shower-events to generate per primary particle.

-p, --primary <primary>#

PDGid of primary to inject. Default is proton. Can be a python dict with different primaries as keys and values the number of events to generate for that. In this case, –events is ignored. Example with proton and iron: {2212: 100_000, 1000260560: 1000}

-o, --output <output>#

Path to store the CORSIKA7 DAT files

-j, --jobs <jobs>#

Number of jobs to use

-c, --corsika <corsika>#

Path to the CORSIKA7 executable. Can also be set using the CORSIKA_PATH environment variable.

-s, --seed <seed>#

Seed to use. If none, will use system time or other entropic source

-t, --tmp <tmp>#

Path to the default temp folder to copy corsika to, will be appended by _n if it is not empty. Can also be set using the TMP_DIR environment variable.

-l, --save-std#

Save CORSIKAs std_out to a log file in output directory.

-fr, --first_run_number <first_run_number>#

Sets the first run number, for multiple output files, the number increments from that number.

-fe, --first_event_number <first_event_number>#

Sets the first event number in each produced DAT file.

-d, --debug#

Enable debug output

Arguments

TEMPLATE#

Required argument