Skip to content

Commit 2d9946e

Browse files
committed
added useful commands and modules, merged sec. 4 and 5
1 parent 0da1ad7 commit 2d9946e

File tree

3 files changed

+108
-12
lines changed

3 files changed

+108
-12
lines changed

content/notes/slurm-from-cli/section2.md

+55
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,61 @@ Angle brackets `< >` indicate a value to be specified, and are not typed.
110110

111111
See also our [documentation](https://www.rc.virginia.edu/userinfo/rivanna/slurm/) for many more examples.
112112

113+
114+
115+
## Modules
116+
117+
Any application software that you want to use will need to be loaded with the `module load` command.
118+
119+
For example:
120+
121+
```
122+
$ module avail matlab
123+
$ module spider anaconda
124+
$ module key goolf R
125+
```
126+
Modules need to be loaded any time that a new shell is created to setup the same working environment. This includes every time that you log out and back in, and every time that you run a batch job on a compute node.
127+
128+
### Module Details
129+
130+
`module avail` – Lists all available modules and versions.
131+
132+
`module spider` – Shows all available modules
133+
134+
`module key keyword` – Shows modules with the keyword in the description
135+
136+
`module list` – Lists modules loaded in your environment.
137+
138+
`module load mymod` – Loads the default module to set up the environment for some software.
139+
140+
`module load mymod/N.M` – Loads a specific version N.M of software mymod.
141+
module load compiler mpi mymod – For compiler- and MPI- specific modules, loads the modules in the appropriate order and, optionally, the version.
142+
143+
`module purge` – Clears all modules.
144+
145+
### Learning more about a Module
146+
147+
To locate a python module, try the following:
148+
149+
```
150+
$ module avail python
151+
$ module spider python
152+
$ module key python
153+
```
154+
155+
To find bioinformatics software packages, try this:
156+
157+
```
158+
$ module key bio
159+
```
160+
161+
The available software is also listed on our [website](https://www.rc.virginia.edu/userinfo/rivanna/software/complete-list/)
162+
163+
**Question:**
164+
165+
Why does the command `module load R` give an error?
166+
167+
113168
## Working with Files and Folders
114169

115170
When using Slurm in terminal mode, you will probably want to create your own folders to organize your Slurm scripts, any input files, and the output. You will need to be able to move around from one folder to another at the terminal.

content/notes/slurm-from-cli/section4.md

+53
Original file line numberDiff line numberDiff line change
@@ -147,3 +147,56 @@ You can also cancel individual tasks
147147
```bash
148148
scancel 1283839_11
149149
```
150+
151+
## Useful Commands
152+
153+
When you submit a job and it doesn't start or fails for an unknown reason it could be due to restraints in your account. This could include running out of storage space or SUs on your allocation. Additionally, it's useful to see how busy the queue is. The following subsections highight how to identify these problems.
154+
155+
### Allocations
156+
157+
Sometimes it’s useful to check how many SUs are still available on your allocation. The `allocations` command displays information on your allocations and how many SUs are associated with them:
158+
159+
```
160+
$ allocations
161+
Account Balance Reserved Available
162+
----------------- --------- --------- ---------
163+
hpc_training 1000000 0 999882
164+
```
165+
166+
running `allocations -a <allocation_name>` provides even more detail on when the allocation was last renewed and its members. E.g.
167+
168+
```
169+
$ allocations -a hpc_training
170+
Description StartTime EndTime Allocated Remaining PercentUsed Active
171+
----------- ------------------- ---------- ----------- ---------- ----------- ------
172+
new 2024-05-29 17:33:13 2025-05-29 1000000.000 999881.524 0.01 True
173+
174+
Name Active CommonName EmailAddress DefaultAccount
175+
------ ------ ------------------------------ ------------------- ----------------------
176+
.
177+
.
178+
.
179+
```
180+
181+
### Storage Quota
182+
One way to check your storage utilization is with the `hdquota` command. This command will show you how much of your home, scratch, and leased (if applicable) storage are being utilized. Below is the sample output for `hdquota`:
183+
184+
```
185+
$ hdquota
186+
Type Location Name Size Used Avail Use%
187+
====================================================================================================
188+
home /home mst3k 50G 16G 35G 32%
189+
Scratch /scratch mst3k 12T 2.0T 11T 17%
190+
```
191+
192+
This is a useful command to check whether or not you’re running out of storage space or to see where files need to be cleaned up. For more detailed information on disk utilization you may also use the `du` command to investiage specific directories.
193+
194+
### Queue limits and Usage
195+
196+
To gain information on the different queues you can use the `qlist` command. This will show the list of paritions, their usage, and the SU charge rate. You can use `qlimits` for information on each queue’s limits.
197+
198+
The the `sinfo` command will provide some more detailed information on the health of each queue and the number of active nodes available. These commands can be useful in diagnosing why a job may not be running, or to better understand the queue usage for more efficient job throughput. More information on hardware specifications and queue information can be found [here](https://rc.virginia.edu/userinfo/rivanna/overview/#hardware-configuration) on our website.
199+
200+
## Need Help
201+
202+
Research Computing is ready to help you learn to use our systems efficiently. You can [submit a ticket](https://www.rc.virginia.edu/form/support-request/). For in-person help, please attend one of our weekly sessions of [office hours](https://www.rc.virginia.edu/support/#office-hours).

content/notes/slurm-from-cli/section5.md

-12
This file was deleted.

0 commit comments

Comments
 (0)