diff --git a/docs/running/jobreport.md b/docs/running/jobreport.md new file mode 100644 index 00000000..ee8880f0 --- /dev/null +++ b/docs/running/jobreport.md @@ -0,0 +1,272 @@ +[](){#ref-jobreport} +# Job report + +A batch job summary report is often requested in project proposals at CSCS to demonstrate the effective use of GPUs. +[jobreport](https://github.com/eth-cscs/alps-jobreport/releases) is used in two stages. +The first stage monitors an application and records the GPU usage statistics. +The monitoring stage must be executed within a `slurm` environment. +The information is recorded as `.csv` data within a directory `jobreport_${SLURM_JOB_ID}` or a directory supplied on the command line. +The second stage prints this information in a tabular form that can be inserted into a project proposal. + +## Downloading the job summary report tool + +A precompiled binary for the `jobreport` utility can be obtained directly from the [repository](https://github.com/eth-cscs/alps-jobreport/releases) or via the command line: + +```console +$ wget https://github.com/eth-cscs/alps-jobreport/releases/download/v0.1/jobreport +$ chmod +x ./jobreport +``` +## Command line options + +A full list of command line options with explanations can be obtained by running the command with the `--help` option: + +```console +$ ./jobreport --help +Usage: jobreport [-v -h] [subcommand] -- COMMAND + +Options: + -h, --help Show this help message + -v, --version Show version information + +Subcommands: + monitor Monitor the performance metrics for a job. (Default) + -h, --help Shows help message + -o, --output Specify output directory (default: ./jobreport_) + -u, --sampling_time Set the time between samples (default: automatically determined) + -t, --max_time