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.

Documented files

This website contains the documentation of the python job framework and scripts, as well as the stdhep-tools written in C++. For additional information of how to use the job scripts, refer to the examples directory and the comments in there. The prod directory is used to organize all scripts that are used to produce and analyze (MC) data.

External documentation

The generators and stdhep-lib are documented in the following places:

Installation

For a detailed installation guide, including prerequisites and environment setup, please refer to the README.

Quick Start Guide

In addition to the installation guide, the README also includes instructions on how to run job scripts and a quick start guide.

Help

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.