SLURM Cluster
Waiting for training slides, please use these documents :
BATCH
sbatch: submit a batch job to slurm (default workq partition).
sarray: submit a batch job-array to slurm.
INTERACTIVE
srun --pty bash : submit an interactive session with a compute node (default workq partition).
INTERACTIVE with X11 forwarding
For the first time, create your public key as below (onto genologin server)
$ ssh-keygen (and "Enter" for all question)
$cat .ssh/id_rsa.pub >> .ssh/authorized_keys
srun --x11 --pty bash : submit an interactive session with X11 forwarding (default workq partition).
INTERACTIVE inside a batch job
srun --pty --jobid jobid bash: convenient to follow a batch job (connection on the node where the batch is running
srun
-J job name
-> for change the jobname
-p partition
-> which partition(~ queue) to use
--time=
HH:MM:SS
-> max time of the job
--pty bash
-> submit an interactive session with a compute node (default workq partition)
--pty bash -l
-> submit an interactive session with login shell (load .bash_profile) on a compute node (default workq partition).
-o (--output) = output_filename
: to specify the stdout redirection. If -e (--error) is not specified both stdout ans stderr will be directed to the file name specified.
-e (--error) = error_filename
: if specified, stderr will be redirected to different location as stdout
1 - First write a script (ex: myscript.sh) with the command line as following:
#!/bin/bash
(the email address is automatically LDAP account's one)
#SBATCH -J test
#SBATCH -o output.out
#SBATCH -e error.out
#SBATCH -t 01:00:00
#SBATCH --mem=8G
#SBATCH --mail-type=BEGIN,END,FAIL
#Purge any previous modules
module purge
#Load the application
module load bioinfo/ncbi-blast-2.2.29+
# My command lines I want to run on the cluster
blastall ...
2 - To submit the job, use the sbatch command line as following:
sbatch myscript.sh
To change memory reservation, add this option to the submission command (sbatch, srun, sarray):
--mem=XG
(default value is 2G)
With default parameters, each job is limited to 1 cpu.
To book more, use the following options:
# Book n cpus on the same node (up to 64)
-c ncpus (--cpus-per-task=ncpus)
# Book n cpus on any nodes in case of MPI jobs
-N nnodes (--nodes=nnodes)
-n ntasks (--ntasks=ntasks)
--ntasks_per_node
Genobioinfo Cluster
Each job is submitted to a specific partition (the default one is the workq).
Each partition has a different priority considering the maximum time of execution allowed.
The partition is configurable with -p option.
Queue | Access | Priority | Max time | Max slots |
---|---|---|---|---|
workq | everyone | 100 | 4 days (96h) | 4992 |
unlimitq | everyone | 1 | 90 days | 780 |
interq (OOD) | on demand | 12h | 32 | |
gpuq | on demand | 4 days (96h) | 64 | |
wflowq | specific software | 90 days | 4992 |
To submit an array of jobs, use sarray command (same sbatch options):
1. create a file with one command per line (prefix by module load if needed)
eg : file star_cmd.txt contains:
module load bioinfo/STAR-2.6.0c; STAR -genomeDir referenceModel --readFilesIn ech1.R1.fastq ech1.R2.fastq ...
module load bioinfo/STAR-2.6.0c; STAR -genomeDir referenceModel --readFilesIn ech2.R1.fastq ech2.R2.fastq ...
module load bioinfo/STAR-2.6.0c; STAR -genomeDir referenceModel --readFilesIn ech3.R1.fastq ech3.R2.fastq ...
2. launch sarray with sbatch option
sarray -J jobName -o %j.out -e %j.err -t 01:00:00 --mem=8G --mail-type=BEGIN,END,FAIL star_cmd.txt
For more information about how to create the command file go to FAQ Bioinfo tips ("How to generate an sarray command file with ....")
To know your quota, use the command:
squota_cpu
Academic account quota: 100 000 h/per calendar year
Beyond these 100,000 hours, you will need to submit a science project (by the resources request form) to estimate the real needs of the bioinformatics environment.
According to results from this evaluation, but also their geographical and institutional origin, users can then either continue their treatments or be invited to contribute financially to infrastructure, or be redirected to regional or national mésocentres calculation.
Non-academic account quota: 500 h/per calendar year for testing the infrastructure.
Overtime calculation will be charged (price on request).
Use the following command line (on genologin server):
mmlsquota -u username --block-size G
Example of a full bash script :
#!/bin/bash
#SBATCH -J mpi_job
#SBATCH --nodes=2
#SBATCH --tasks-per-node=6
#SBATCH --time=00:10:00
cd $SLURM_SUBMIT_DIR
module purge
module load mpi/openmpi/4.1.4
mpirun -n $SLURM_NTASKS --map-by ppr:$SLURM_NTASKS_PER_NODE:node ./hello_world
To do so, you can use the squeue command, following are some usefull options:
squeue -u username
: list only the specified user's jobs.
squeue -j job_id
: provide several informations on the specified job.
(see squeue --help
or man squeue
for more options)
For more detail:
scontrol show job job_id
You can also have access to a graphical user interface which provides the same informations.
This interface is accessible with the sview command.
The srun command can be used to check in on a running job in the cluster.
srun --pty --jobid= bash
: starts a shell, where you can run any command, on the first allocated node in a specific job.
To check processor and memory usage quickly, you can run top directly:
srun --pty --jobid= top -u login
To do so, use the sacct command line as following:
sacct -j job_id
(see sacct --help
or man sacct
for more options)
To do so, you can use the scancel command, following are some usefull options:
# Kill the specified job
scancel job_id
# Kill all job launched by the specified user
scancel -u username
On a test job in COMPLETED state, check the result of the seff command:
seff jobid
and adjust time with -t , memory with --mem et cpu with --cpus-per-task options.
The smaller a job, the faster it is processed. Set your different pre-allocations (time, memory and cpu) as closely as possible to your needs.
On a test job in COMPLETED state, check the result of the seff command:
seff jobid
and adjust time with -t , memory with --mem et cpu with --cpus-per-task options.
On Genobioinfo cluster:
-> Request access to the GPU node here.
-> Example in a sbatch script:
#SBATCH --partition=gpuq
#SBATCH --gres=gpu:A100_1g.10gb:1 #(if you want to reserve 1 partition with 10GB RAM)
#SBATCH --gres=gpu:A100_2g.20gb:1 #(if you want to reserve 1 partition with 20GB RAM)
#SBATCH --gres=gpu:A100_3g.40gb:1 #(if you wish to reserve 1 partition with 40GB RAM)
#SBATCH --gres=gpu:A100:1 #(if you wish to reserve 1 full board with 80GB RAM)
You continue to reserve CPU threads (-c, --cpus_per_task) and RAM memory (--mem) in the same way as before.
-> Interactive mode:
$ srun --partition=gpuq --pty bash
-> Limitation rules
- No more than 32 CPUs are reserved per job
- No more than 2 GPUs are reserved per user.
You must be very careful to disconnect from an interactive GPU session (launched with srun) after your use of GPU is finished. Keeping the connection alive would lead to a high usage of computing ressources that are shared and limited.
-> To monitor GPU usage, 2 commands are available on the GPU node:
$ nvidia-smi
$ gpustat
Ask access to Visu node (interq) by filling the ressource request form here.
- RStudio: Training Slides
- Jupyter: Training Slides
- Linux Desktop: Training Slides