@@ -5,9 +5,17 @@ STUBL - SLURM Tools and UBiLities
5
5
STUBL is a collection of supplemental tools and utilitiy scripts for `SLURM
6
6
<http://slurm.schedmd.com/> `_.
7
7
8
- -----------
8
+ -------------
9
+ REQUIREMENTS
10
+ -------------
11
+
12
+ A few commands included in STUBL require `clush <http://cea-hpc.github.io/clustershell/ >`_.
13
+ For rhel based systems clush is in `EPEL <https://fedoraproject.org/wiki/EPEL >`_. Debian
14
+ based systems can run *apt-get install clush *.
15
+
16
+ -------------
9
17
INSTALL
10
- -----------
18
+ -------------
11
19
12
20
- To install STUBL download the `latest release <https://github.com/ubccr/stubl/releases >`_::
13
21
@@ -68,14 +76,14 @@ Summary of STUBL SLURM Commands
68
76
- *sqstat *
69
77
70
78
A customized version of squeue that produces output analogous to the PBS
71
- qstat and xqstat commands.
79
+ qstat and xqstat commands (requires clush) .
72
80
73
81
- *fisbatch *
74
82
75
83
Friendly Interactive SBATCH. A customized version of sbatch that provides a
76
84
user-friendly interface to an interactive job with X11 forwarding enabled. It
77
85
is analogous to the PBS "qsub -I -X" command. This code was adopted from
78
- `srun.x11 <https://github.com/jbornschein/srun.x11 >`_.
86
+ `srun.x11 <https://github.com/jbornschein/srun.x11 >`_. (requires clush)
79
87
80
88
- *sranks *
81
89
@@ -93,12 +101,12 @@ Summary of STUBL SLURM Commands
93
101
- *sjeff *
94
102
95
103
Determines the efficiency of one or more running jobs. Inefficient jobs are
96
- high- lighted in red text.
104
+ high- lighted in red text (requires clush) .
97
105
98
106
- *sueff *
99
107
100
108
Determines the overall efficiency of the running jobs of one or more users.
101
- Users that are inefficient are highlighted in red text.
109
+ Users that are inefficient are highlighted in red text (requires clush) .
102
110
103
111
- *yasqr *
104
112
@@ -123,7 +131,7 @@ Summary of STUBL SLURM Commands
123
131
- *slist *
124
132
125
133
Retrieves SLURM accounting and node information for a running or completed
126
- job.
134
+ job (requires clush) .
127
135
128
136
- *slogs *
129
137
0 commit comments