robin is a tool for easy job managment on HPC like referencing by name, logging, logging into nodes.
Works on Slurm, PBSPro, and tmux.
-
In case you don't have internet access there, you can use
mitten(https://github.com/unkaktus/mitten). -
Download and install the
robinbinary:
curl -L -o robin https://github.com/unkaktus/robin/releases/latest/download/robin-linux-amd64
mkdir -p ~/bin
mv robin ~/bin/
chmod +x ~/bin/robin- Add
$HOME/bininto your$PATHinto your.bashrc:
export PATH="$HOME/bin:$PATH"-
Install Go (https://go.dev)
-
Build
robinfor Linux:
git clone https://github.com/unkaktus/robin
cd robin/cmd/robin
env GOOS=linux GOARCH=amd64 go buildscptherobinbinary to your favorite supercomp and add it to your$PATH.
$ robin list
╭───────────────────────┬─────────┬───────┬─────────────────────────┬───────╮
│ NAME │ STATE │ QUEUE │ TIME │ NODES │
├───────────────────────┼─────────┼───────┼─────────────────────────┼───────┤
│ Compare_Apples │ R [0] │ small │ [8%] 2h0m41s/24h0m0s │ 8 │
│ Compare_Oranges │ Q [0] │ small │ [0%] 0s/20h0m0s │ 2 │
│ Compare_Bananas │ F [9] │ small │ [0%] 0s/20h0m0s │ 16 │
╰───────────────────────┴─────────┴───────┴─────────────────────────┴───────╯Open full logs in $EDITOR (defauts to vim):
$ robin logs Compare_ApplesFollow the log tail of a job:
$ robin logs -f Compare_ApplesTo connect to the shell on the job nodes, you first need
to start your job binary via robin nest:
export MPI_SHEPHERD=true # Needed for PBSPro
[mpirun -n 16] robin nest ./exe/binaryThen, to connect to the shell of the node 1 (starting from 0) of running job Compare_Apples:
$ robin shell Compare_Apples/1
node123$Using robin exec, you can execute a single command on the job nodes:
$ robin exec Compare_Apples/4 "ps aux"
PID TTY TIME CMD
9993 ttys000 0:00.05 compare_applesCancel job Compare_Apples:
$ robin cancel Compare_ApplesForward a port to the node of a job:
$ robin port-forward -p 11111 -m supercomp compare_applesYou might want to add the following function to your .bashrc,
that will bring you to the directory from which the job was submitted:
cdj () {
cd $(robin list --json | jq -r '.[] | select(.Name=="'$1'").WorkingDirectory')
}Note that it requires jq.