Skip to content

Commit 4c13dc5

Browse files
committed
Updated install docs to include clush dependency
1 parent e8a03e3 commit 4c13dc5

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

ChangeLog.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
ChangeLog
22
===========
33

4+
v0.0.4
5+
----------------------
6+
7+
- Updated install docs to include clush dependency
8+
49
v0.0.3
510
----------------------
611

README.rst

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,17 @@ STUBL - SLURM Tools and UBiLities
55
STUBL is a collection of supplemental tools and utilitiy scripts for `SLURM
66
<http://slurm.schedmd.com/>`_.
77

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+
-------------
917
INSTALL
10-
-----------
18+
-------------
1119

1220
- To install STUBL download the `latest release <https://github.com/ubccr/stubl/releases>`_::
1321

@@ -68,14 +76,14 @@ Summary of STUBL SLURM Commands
6876
- *sqstat*
6977

7078
A customized version of squeue that produces output analogous to the PBS
71-
qstat and xqstat commands.
79+
qstat and xqstat commands (requires clush).
7280

7381
- *fisbatch*
7482

7583
Friendly Interactive SBATCH. A customized version of sbatch that provides a
7684
user-friendly interface to an interactive job with X11 forwarding enabled. It
7785
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)
7987

8088
- *sranks*
8189

@@ -93,12 +101,12 @@ Summary of STUBL SLURM Commands
93101
- *sjeff*
94102

95103
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).
97105

98106
- *sueff*
99107

100108
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).
102110

103111
- *yasqr*
104112

@@ -123,7 +131,7 @@ Summary of STUBL SLURM Commands
123131
- *slist*
124132

125133
Retrieves SLURM accounting and node information for a running or completed
126-
job.
134+
job (requires clush).
127135

128136
- *slogs*
129137

0 commit comments

Comments
 (0)