Command-line tools

Gstat

Gstat

Summarize the status of the jobs (wrapper around “squeue”).

Usage:

Gstat [options] Gstat [options] [–jobid=N…] [–host=N…] [–user=N…] [–name=N…] [–account=N…] [–partition=N…] [–sort=N…] [–output=N…]

Options:
-U

Limit output to the current user.

-u, --user=<NAME>

Limit output to user(s) (may be a regex).

-j, --jobid=<NAME>

Limit output to job-id(s) (may be a regex).

-h, --host=<NAME>

Limit output to host(s) (may be a regex).

-a, --account=<NAME>

Limit output to account(s) (may be a regex).

-n, --name=<NAME>

Limit output to job-name(s) (may be a regex).

--status=<NAME>

Limit output to status (may be a regex).

-p, --partition=<NAME>

Limit output to partition(s) (may be a regex).

-s, --sort=<NAME>

Sort by field (selected by the header name).

-r, --reverse

Reverse sort.

-o, --output=<NAME>

Select output columns (selected by the header name).

--full-name

Show full user names.

-S, --summary

Print only summary.

--no-header

Suppress header.

--no-truncate

Print full columns, do not truncate based on screen width.

--width=<N>

Set print with.

--colors=<NAME>

Select color scheme from: none, dark. [default: dark]

-l, --list

Print selected column as list.

--sep=<NAME>

Set column separator. [default: ] (space)

--long

Print full information (each column is printed as a line).

--debug=<FILE>

Debug: read squeue -o "%all" from file.

--help

Show help.

--version

Show version.

(c - MIT) T.W.J. de Geus | tom@geus.me | www.geus.me | github.com/tdegeus/GooseSLURM

Ginfo

Ginfo

Summarize the status of the compute nodes (wrapper around “sinfo”).

The following scores are computed of each node:

  • CPU% : The CPU load of the node relative to the number of jobs (cpu_load / cpu_used). Should always be ~1, anything else usually signals misuse.

  • Mem% : the amount of used memory relative to the average memory available per job ((mem_used / cpu_used) / (mem_tot / cpu_tot)). Can be > 1 for (several) heavy memory consumption jobs, but in principle any value is possible.

Usage:

Ginfo [options] Ginfo [options] [–jobid=N…] [–host=N…] [–user=N…] [–cfree=N…] [–partition=N…] [–sort=N…] [–output=N…] [–debug=N…]

Options:
-U

Limit output to the current user.

-u, --user=<NAME>

Limit output to user(s) (may be a regex).

-j, --jobid=<NAME>

Limit output to job-id(s) (may be a regex).

-h, --host=<NAME>

Limit output to host(s) (may be a regex).

-f, --cfree=<NAME>

Limit output to free CPU(s) (may be a regex).

-p, --partition=<NAME>

Limit output to partition(s) (may be a regex).

-s, --sort=<NAME>

Sort by field (selected by the header name).

-r, --reverse

Reverse sort.

-o, --output=<NAME>

Select output columns (selected by the header name).

-S, --summary

Print only summary.

--no-header

Suppress header.

--no-truncate

Print full columns, do not truncate based on screen width.

--width=<N>

Set print with.

--colors=<NAME>

Select color scheme from: none, dark. [default: dark]

-l, --list

Print selected column as list.

--sep=<NAME>

Set column separator. [default: ] (space)

--long

Print full information (each column is printed as a line).

--debug=<FILE>

Debug: read ‘sinfo -o “%all”’ (and then squeue) from file.

--help

Show help.

--version

Show version.

(c - MIT) T.W.J. de Geus | tom@geus.me | www.geus.me | github.com/tdegeus/GooseSLURM

Gps

Gps

List memory usage per process.

Usage:

Gps [options] Gps [options] [–user=N…] [–pid=N…] [–command=N…] [–sort=N…] [–output=N…]

Options:
-U

Limit processes to the current user.

-u, --user=<NAME>

Limit processes to user(s) (may be a regex).

-p, --pid=<NAME>

Limit processes to process-id (may be a regex).

-c, --command=<NAME>

Limit processes to command (may be a regex).

-s, --sort=<NAME>

Sort by field (selected by the header name).

-r, --reverse

Reverse sort.

--output=<NAME>

Select output columns (selected by the header name).

--no-header

Suppress header.

--no-truncate

Print full columns, do not truncate based on screen width.

--width=<N>

Set print with.

--colors=<NAME>

Select color scheme from: none, dark. [default: dark]

--list

Print selected column as list.

--sep=<NAME>

Set column separator. [default: ] (space)

--long

Print full information (each column is printed as a line).

--debug=<FILE>

Debug. Output squeue -o "%all" provided from file.

-h, --help

Show help.

--version

Show version.

(c - MIT) T.W.J. de Geus | tom@geus.me | www.geus.me | github.com/tdegeus/GooseSLURM

Gsub

Gsub

Submit job-scripts and add the “–chdir” option to run the scripts from the directory in with the sbatch-file is stored.

Usage:

Gsub [options] <files>…

Arguments:

Job-scripts.

Options:
--dry-run

Print commands to screen, without executing.

--verbose

Verbose all commands and their output.

–log = FILENAME

Log the JobIDs to a YAML-file (updated after each submit). Existing log files are appended.

–delay = FLOAT

Seconds to wait between submitting jobs. [default: 0.1]

-r, –repeat = INT

Submit using dependencies such that the job will be repeated ‘n’ times. [default: 1]

--serial

Submit using dependencies such that jobs are run after each other.

-d, –dependency = ARG (sbatch option)

Defer the start of this job until the specified dependencies have been satisfied completed.

-w, –wait (sbatch option)

Do not exit until the submitted job terminates.

-c, –constraint = ARG (sbatch option)

Nodes can have features assigned to them by the Slurm administrator.

-Q, --quiet

Do no show progress-bar.

-h, --help

Show help.

--version

Show version.

(c - MIT) T.W.J. de Geus | tom@geus.me | www.geus.me | github.com/tdegeus/GooseSLURM

Gdel

Gdel

Stop running jobs.

Usage:

Gdel [options] Gdel [options] <JobId>…

Arguments:

ID-number(s) of the job(s) to delete. (default: all user’s jobs)

Options:
--no-truncate

Print full columns, do not truncate based on screen width.

--width=<N>

Set print with.

--colors=<NAME>

Select color scheme from: none, dark. [default: dark]

--sep=<NAME>

Set column separator. [default: ] (space)

--debug=<FILE>

Debug. Output squeue -o “%all” provided from file.

-h, --help

Show help.

--version

Show version.

(c - MIT) T.W.J. de Geus | tom@geus.me | www.geus.me | github.com/tdegeus/GooseSLURM