This Doxygen website is used for documenting the hps-mc source code, with the exception of the event generators and stdhep-lib that are not original to this project and documented elsewhere.
This website contains the documentation of the python [job framework](@ref jobframework) and [scripts](@ref jobscripts), as well as the [stdhep-tools](@ref stdheptools) written in C++. For additional information of how to use the job scripts, refer to the examples directory and [the comments in there](@ref examples). The [prod](@ref prod) directory is used to organize all scripts that are used to produce and analyze (MC) data.
The generators and stdhep-lib are documented in the following places:
For a detailed installation guide, including prerequisites and environment setup, please refer to the [README](@ref readme).
In addition to the installation guide, the [README](@ref readme) also includes instructions on how to run job scripts and a quick start guide.
You can post any questions or report problems on the HPS Slack in the montecarlo channel.
The HPS software mailing list can also be used for help.