Skip to content

Analysing a simulation

To run HBT-HERONS, you always need to provide a path to a parameter file (<PATH_TO_PARAMETER_FILE>). Several examples of different parameter files are provided in examples/configs. A description of all accepted parameters, their default values, and descriptions can be found in the runtime parameters page.

Analyse all outputs

If you want to analyse all of the outputs of the simulation, the following command will make HBT-HERONS run from the first output (MinSnapshotIndex) to the last one (MaxSnapshotIndex) of the simulation:

mpirun -np <NUMBER_MPI_RANKS> ./HBT <PATH_TO_PARAMETER_FILE>
./HBT <PATH_TO_PARAMETER_FILE>

You can specify the number of OMP threads to use per MPI rank using export OMP_NUM_THREADS=<NUMBER_OMP_THREADS> before running the above command.

Analyse a subset of outputs

If you are interested in running HBT-HERONS for a subset of the outputs, you can specify the range as follows:

mpirun -np <NUMBER_MPI_RANKS> ./HBT <PATH_TO_PARAMETER_FILE> <START_OUTPUT> <END_OUTPUT>
./HBT <PATH_TO_PARAMETER_FILE> <PATH_TO_PARAMETER_FILE> <START_OUTPUT> <END_OUTPUT>

where <START_OUTPUT> is greater or equal than MinSnapshotIndex and <END_OUTPUT> is less or equal to MaxSnapshotIndex. This command is also used to continue a run that already begun but did not have time to finish. In such a case, <START_OUTPUT> is the output number following the last one analysed, and <END_OUTPUT> equals MaxSnapshotIndex.

Warning

Adding the second number is important, since otherwise HBT-HERONS will interpret the