Slurm efficiency tool

A reimplementation of the Slurm efficiency Perl plugin, in Python, with added functionality for reporting GPU usage efficiency.

Installation

We recommend installing with poetry.

git clone git@github.com:kcl-eresearch/hpc_seff_script.git
cd hpc_seff_script/
poetry install

This makes the seff command available in the poetry virtual environment.

Usage

usage: seff [-h] [--timeout TIMEOUT] jobid

Summarize Slurm job efficiency.

positional arguments:
  jobid              Slurm job ID

options:
  -h, --help         show this help message and exit
  --timeout TIMEOUT  Timeout for each command in seconds (default: 20)

Example:

$ seff 1234567
Job ID: 1234567
User: k1234567
State: COMPLETED
Elapsed time: 10:43:19
GPU(s) allocated: none
CPU Efficiency: 95.4% of 6 core(s) used
Memory Efficiency: 1.3% of 6000 MB used