Matilda HPC Powertools

Overview

Matilda HPC "Powertools" have been developed to assist users in accessing useful system information and functionality, but abstracting away the complexities associated with the SLURM into user-friendly scripts. While Powertools is not intended as a full replacement for SLURM, it is hoped it makes common functions more accessible for most user's requirements. [Comments and suggestions are always welcome.] This document contains information on the Powertools modulefile and it's various features. Watch this space, as it will be updated as more tools are developed and/or revised.

Accessing Powertools

You may have access to Powertools as you would with any modulefile:

module load powertools

To view a summary of powertools, simply enter:

powertools

This will produce "man page like" output. You can also enter:

man powertools

Powertools Description

acctBalance

The acctBalance script permits the user to check the usage and allocation balances for the current year for any group of which they are a member. If no time period is specified, then YTD is assumed. You can specify "all" if you want to see all groups. In addition, you may specify a time period, or verbose output (a breakdown of all the users in your group). Please note a YTD account summary is always provided. By default the number of "billing" hours are displayed, where: billing-hours=(cpu-hours + (10 * gpu-hours)). You may also just specify cpu-hours or gpu-hours if desired.

To see the available options, use:

acctBalance -h

Examples

Display billing-hours for all member groups from March 1, 2023 through to the present:

acctBalance -g all -s 2023-03-01 -e now

Display gpu-hours YTD with group user details:

acctBalance -g all -t g -v

List all groups of which the user is a member:

acctBalance -l

acctBalanceAll

This is a simplified version of "acctBalance" which simply lists a YTD summary of billing-hours for all member groups (no user breakdown).

Examples

acctBalanceAll

jobStats

The jobStats script displays information on the user's running jobs. By default, jobStats displays summarized information (no job steps). If you desire jobStep breakdowns, use the "-v" flag.

Examples

Display running job statistics, including start and elapsed time, number of nodes and cores, maximum memory used (MaxRSS), and a list of nodes the job is running on:

jobStats

jobHist

The jobHist script displays any of the user's jobs that are completed (this includes successfully complete, failed, cancelled, etc.). If no arguments are provided, all jobs from the start of the calendar year to the present are displayed. Alternately, the user may specify a time period, or a number of days, weeks, or months prior to the current date. To see input options, please use the "-h" flag (jobStats -h).

Examples

Display all non-running user jobs that have terminated in the last week:

jobHist -p 1w

Display all of the user's non-running jobs over specified time period:

jobHist -s 2023-02-10 -e 2023-02-20

quotaCheck

quotCheck accepts no input arguments. It simply returns the file usage statistics for the user's home directory, and any project directories for groups of which they are a member. Please note, that for shared directories (e.g. those under /projects), the value returned is only for files where the group ownership corresponds to the project group. If there are files present that do not have a group ownership equivalent to the project group (e.g. a file with a group ownership of 'students' or 'faculty'), those files will not be counted in the total.

Examples

quotaCheck

scratchQuota

Similar to quotaCheck, the scratchQuota script takes no input arguments, and simply reports file usage in the user's scratch space, and in their affiliated /scratch/projects space. Once again, please note that files in the /scratch/projects space that have group ownerships other than the project group, will not be counted as part of the total.

Examples

scratchQuota

scratchScript

The scratchScript script examines all files by access time in the user's /scratch/users and /scratch/projects directory spaces, and lists those files that are slated to be deleted. If no input arguments are provided, the list will contain only those files slated to be deleted tomorrow morning. If the "-d D" option is used (where 'D' is an integer number of days, e.g. 5), then access times of 45 - D will be tested. This will provide the desired amount of warning to the user of what files will be deleted in the coming "D" days.

Examples

To see a list and the number of files that will be deleted in 5 days or less:

scratchScript -d 5

This value will be used for both the /scratch/users and /scratch/projects directories.

---

CategoryHPC