Usage

Running Simulations

The examples directory of the Prometheus GitHub repository contains example scripts for running simulations.

As a first-time user, you will need example_ppc.py for ice-based simulations and example_olympus.py for water-based ones. Other scripts cover more specific use case scenarios.

To execute a script, run:

python3 python -m pip <SCRIPT_NAME>.py

Replace <SCRIPT_NAME> with the name of your simulation script.

Getting Help

If something is not working as expected, or you have a question about using this software, feel free to create a discussion on GitHub and we will address it as soon as we can.

If you found a bug or want to suggest a change, feel free to open an issue on GitHub or make a contribution.

More information on contributing to Prometheus is available in our contribution guidelines.