View source for Batch System PBSPro (vulcan)

== Introduction ==

The only way to start a job (parallel or single node) on the compute nodes of this system is to use the batch system. The installed batch system is PBSPro.

Writing a submission script is typically the most convenient way to submit your job to the batch system.
You generally interact with the batch system in two ways: through options specified in job submission scripts (these are detailed below in the examples) and by using PBSPro commands on the login nodes. There are three key commands used to interact with PBSPro:

* qsub
* qstat
* qdel

Check the man page of PBSPro for more advanced commands and options
  man pbs_professional
----

== Requesting Resources using batch system ==
Resources are allocated to jobs both by explicitly requesting them and by applying specified  defaults. <BR>
Jobs  explicitly request resources either at the host level in chunks defined in a selection statement, or in job-wide resource requests.
<UL>
Format:
<li> job wide request:
<pre>   qsub ... -l <resource name>=<value> </pre>
The only resources that can be in a job-wide request are server-level or queue-level resources, such as walltime.
</li>
<li> selection statement:
<pre>   qsub ... -l select=<chunks> </pre>
The only resources that can be requested in chunks are host-level resources, such  as  mem  and  ncpus.
A chunk is the smallest set of resources  that will  be  allocated  to  a  job.   It is one or more resource_name=value statements separated by a colon, e.g.:
<pre>ncpus=2:mem=32GB</pre>
 A  selection statement is of the form:
<pre>  -l select=[N:]chunk[+[N:]chunk ...] </pre>
{{Note|text =
If N is not specified, it is taken to be 1.
No spaces are allowed between chunks.
}}

</li>

</UL>

{{Warning|text = all requested cluster nodes will be exclusively allocated by 1 job. The default nodes can not be shared by multiple jobs. The allocated nodes of your job will be accounted completely, even though your job uses the allocated nodes only  partial}}
=== Node types ===
You have to specify the resources you need for your batch job. These resources are specified by including them in the -l argument (selection statement and job-wide resources) on the qsub command or in the PBS job script.
The 2 important resources you have to specify are <font color=red>number of nodes of a specific node type</font> in the selection statement and the <font color=red>walltime</font> in the job-wide resource request you need for this job:
<ol>
  <font color=red><li><pre>select=<number of nodes>:<node_resource_variable=type></pre></li></font>
  <ul>To distinguish between different nodes 4 node resource variables are assigned to each node. The '''''node_type''''', '''''node_type_cpu''''', '''''node_type_mem''''' and '''''node_type_core''''' of each node. You have to specify at least one of the resource variable or you can specify a valid available combination of the resources for a specific type of nodes. For some special nodes there are also the resources '''''localscratch''''' and '''''linkspeed''''' available.
{|border="1" cellpadding="2"
|+'''Available node types:'''
|-
|'''node_type'''||'''node_type_cpu'''||'''node_type_mem'''||'''node_type_core'''|| '''Graphic'''||'''localscratch'''||'''linkspeed'''|||'''describes'''||'''notes'''||'''# of nodes (laki)'''||'''# of nodes (laki2)
|-
|''[[sb| sb]]''|| SandyBridge@2.60GHz || 32gb || 16c || || || QDR || cpu type intel sandy bridge, 32GB memory|| 2 octa core-CPU per node||98||178
|-
|''[[sb| sb]]''|| SandyBridge@2.60GHz || 64gb || 16c || || || QDR || cpu type intel sandy bridge, 64GB memory|| 2 octa core-CPU per node||6||10
|-
|''[[sb| sb]]''|| SandyBridge@2.60GHz || 64gb || 16c || || || FDR || cpu type intel sandy bridge, 64GB memory|| 2 octa core-CPU per node||24||0
|-
|''[[sb| sb]]''|| SandyBridge@2.60GHz || 128gb || 16c || || || QDR || cpu type intel sandy bridge, 128GB memory|| 2 octa core-CPU per node||0||4 (1 shared)
|-
|''[[hsw|hsw]]''|| Haswell@2.60GHz || 128gb || 20c || || || QDR || cpu type intel haswell, 128GB memory|| 2 x 10 core-CPU 2.6 ghz per node||84||0
|-
|''[[hsw|hsw]]''|| Haswell@2.60GHz || 256gb || 20c || || || QDR || cpu type intel haswell, 256GB memory|| 2 x 10 core-CPU 2.6 ghz per node||4||0
|-
|''[[hsw|hsw]]''|| Haswell@2.50GHz || 128gb || 24c || || || QDR || cpu type intel haswell, 128GB memory|| 2 x 12 core-CPU 2.5 ghz per node||200||0
|-
|''[[hsw|hsw]]''|| Haswell@2.50GHz || 128gb || 24c || || || FDR || cpu type intel haswell, 128GB memory|| 2 x 12 core-CPU 2.5 ghz per node||144||0
|-
|''[[hsw|hsw]]''|| Haswell@2.50GHz || 256gb || 24c || || || QDR|| cpu type intel haswell, 256GB memory|| 2 x 12 core-CPU 2.5 ghz per node||16||0
|-
|''[[mem256gb|il]]''|| Interlagos@2.6GHz || 256gb || 48c || || || QDR || interlagos node with 256GB memory|| ||6||0
|-
|''[[mem256gb|il]]''|| Interlagos@2.6GHz || 256gb || 48c || || 4TB || QDR || interlagos node with 256GB memory, 4TB local scratch disk|| ||4||0
|-
|''ib''|| IvyBridge@3.3Ghz || 384gb || 16c || Tesla K20Xm      || 11TB || QDR || node with intel IvyBridge@3.3Ghz, 16 cores, 384GB memory, 11TB local SSD scratch disk, Tesla K20Xm|| only for single node jobs available ||3||0
|-
|''nh''|| Nehalem_EX@2.67GHz || 1024gb || 48c || || || SDR || cpu type intel nehalem, 1TByte memory,8 socket 6 core CPU's|| will be shared with other jobs!<font color=red> Please use <tt>"qsub -q smp -l select=1:node_type=nh ..." </tt></font>||1 (shared)||0
|-
|''nh''||  Nehalem@2.8GHz || 144gb || 8c || || 6TB || SDR || cpu type intel nehalem, 148GB memory, 6TB local scratch || 2 octa core-CPU per node + local scratch disk||1||0
|-
|''fx5800''|| Nehalem@2.93GHz || 24gb || 4c || Quadro FX 5800 || || SDR || Graphic node Nvidia Quadro FX 5800, 8 core intel W3540, 24GB memory|| only 1 node per job! <font color=red> Please use <tt>"qsub -q vis -l select=1:node_type=fx5800 ..." </tt></font>||4||1
|-
|''gtx680''|| Nehalem@2.53GHz || 12gb || 4c || GTX680 || || SDR || Cuda Node with GTX680, 8 core intel E5540, 12GB memory|| only 1 node per job! ||2||0
|}


'''Multi node type job can also be specified using a ''+'':'''
<ul>
<pre>select=1:node_type=hsw:node_type_mem=256gb+3:node_type=hsw:node_type_mem=128gb:node_type_core=20c</pre>
The example above will allocate 1 hsw node (a 20 core ore 24 core type) with 256 GB memory and 3 hsw nodes (the 20 cores type) with 128 GB memory.
</ul>


To allocate special nodes with local disk you can use the special node resource variable '''''localscratch''''':
<ul>
<pre>select=1:node_type=il:localscratch=4TB</pre>
</ul>
Or you want hsw nodes with network interconnect FDR, then you can use the special node resource variable  '''''linkspeed''''':
<ul>
<pre>select=4:node_type=hsw:linkspeed=FDR</pre>
</ul>

</ul>
<font color=red><li><pre>walltime=<time></pre></li></font>
</OL>

=== Batch Mode ===
Production jobs are typically run in batch mode. Batch scripts are shell scripts containing flags and commands to be interpreted by a shell and are used to run a set of commands in sequence.
* The number of required nodes, cores, wall time and more can be determined by the parameters in the job script header with "#PBS" before any executable commands in the script.
<pre>
#!/bin/bash
#PBS -N job_name
#PBS -l select=2:node_type=hsw:mpiprocs=24
#PBS -l walltime=00:20:00             
  
# Change to the direcotry that the job was submitted from
cd $PBS_O_WORKDIR

# using the INTEL MPI module
module load mpi/impi

# Launch the parallel mpi application (compiled with intel mpi) to the allocated compute nodes
mpirun -np 48  ./my_mpi_executable arg1 arg2 > my_output_file 2>&1
</pre>
* The job is submitted by the '''qsub''' command (all script head parameters #PBS can also be adjusted directly by '''qsub''' command options). 
  qsub my_batchjob_script.pbs
* Setting qsub options on the command line will overwrite the settings given in the batch script:
  qsub -N other_name -l select=2:node_type=hsw:mpiprocs=24 -l walltime=00:20:00 my_batchjob_script.pbs
* The batch script is not necessarily granted resources immediately, it may sit in the queue of pending jobs for some time before its required resources become available.  
* At the end of the execution output and error files are returned to your HOME directory
* This example will run your executable "my_mpi_executable" in parallel with 48 MPI processes (mpiprocs=24 is the number of MPI processes on each node) . The batch system will allocate 2 nodes to your job for a maximum time of 20 minutes and place 24 processes on each node. The batch systems allocates nodes exclusively only for one job. After the walltime limit is exceeded, the batch system will terminate your job.  The '''mpirun''' example above will start the parallel executable "my_mpi_executable" with the arguments "arg1" and "arg2". The job will be started using 48 MPI processes with 24 processes placed on each of your allocated nodes. You need to have nodes allocated by the batch system (qsub) before starting mpirun.

{{Note|text =
<li> While your job is running (in Batch Mode), STDOUT and STDERR are written to a file or files in a system directory and the output is copied to your submission directory (PBS_O_WORKDIR) only after the job completes. Specifying the
<pre>qsub -W sandbox=PRIVATE my_batchjob_script.pbs</pre> 
option here and redirecting the output to a file (see example above) makes it possible for you to view STDOUT and STDERR of your job scripts while the job is running. PBSPro creates a job-specific directory in your home directory for the staging and execution during the job is running.</li>
}}

=== Interactive batch Mode ===
Interactive mode is typically used for debugging or optimizing code but not for running production code. To begin an interactive session, use the "qsub -I" command:
  qsub -I -l select=2:node_type=hsw:ncpus=24:mpiprocs=24 -l walltime=00:30:00

If the requested resources are available and free (in the example above: 2 hsw nodes/24 cores each, 30 minutes, prepared for 24 mpi processes on each node), then you will get a new session on the jobs head node for your requested resources.
Now you have to use the '''mpirun''' command to launch your parallel application to the allocated compute nodes.
When you are finished, enter '''logout''' to exit the batch system and return to the normal command line.


=== PBS_NODEFILE (MPI usage of multi-socket nodes and multi-core cpus) ===
In most MPI environments, the PBS_NODEFILE will be usefull to start the correct number of mpi processes on each allocated node.
The jobs <tt>${PBS_NODEFILE}</tt> contents depends on the number of MPI processes for each requested chunk.
Inside a select statement of each chunk you can define a '''mpiprocs''' option (Type: integer).
The  number  of  lines  in  PBS_NODEFILE  is the sum of the values of mpiprocs for all chunks requested by the job.  For each chunk with mpiprocs=P, the host name for that chunk is written to the PBS_NODEFILE P times.
  

'''Example:'''
  qsub -l select=2:node_type=sb ./myscript
The batch system allocates two node of type sb. The file <tt>${PBS_NODEFILE}</tt> contains:
  node1
  node2
----
If the chunk request has the option <tt>mpiprocs</tt> defined, then it is possible to allocate the defined PE's on a node. This option especially allow OpenMPI to place the MPI processes of ranks on a shared node or alternatively on distributed nodes. 


'''select example with 2 chunk requests (seperated by '+'):'''
  qsub -l select=2:sb:mpiprocs=2+1:node_type=sb:mpiprocs=3 ./myscript
The batch system allocates 2 nodes of type sb each for 2 PE's and 1 node of type sb for 3 PE's. Then the file <tt>${PBS_NODEFILE}</tt> contains:
  node1
  node1
  node2
  node2
  node3
  node3
  node3

=== Defaults for Ressource Requests ===
If you don't set the resources for your job request, then you will get default resource limits for your job.
{|border="1" cellpadding="2"
|-
|'''resource'''||'''value'''||'''notes'''
|-
|select||1|||
|-
|mpiprocs||1|||
|}

Please select your resource requests carefull. 

To have the same '''environmental settings''' (exported environment) of your current session in your batchjob, the ''qsub'' command needs the option argument ''-V''.

=== Run job on other Account ID ===

There are Unix groups associated to the project account ID (ACID). To run a job on a non-default project budget, the
groupname of this project has to be passed  in the group_list:

<pre>qsub -l select=1:node_type=hsw -W group_list=<groupname></pre>

To get your available groups:

<pre>id -Gn</pre>
{{Warning|text=  note that this procedure is neither applicable nor necessary for the default project
(associated to the primary group), printed with "id -gn".}}

=== Usage of a Reservation ===

For nodes which are reserved for special groups or users, you need to specify additional the queue which is intended for this reservation:
: E.g. a reservation of some nodes is bound to the queue named ''workday'':
 
 qsub -q workday -l select=1:node_type=hsw -l walltime=1:00 testjob.cmd

Following reservations are availalble at the moment:

{|border="1" cellpadding="2"
|-
|'''reservation'''||'''resources'''||'''queue'''||'''limitations'''||'''notes'''
|-
|S373||1 node of node_type sb||workday for routing to S373||valid on Mo-Fr 6:00-18:00, user- and group-run limits, walltime limit, nodecount limits will be set for jobs using this reservation||This daytime reservation should be used for jobs with a short walltime
|}

=== Job Arrays ===

Job arrays are groups of similar jobs. Those jobs usually have slightly different parameters which depend on the current job index. 
This job index will be available in the $PBS_ARRAY_INDEX variable, which can be used in job scripts to calculate or generate any kind of job-specific (input)data.

Job arrays can be requested with 
<pre>qsub -J <range> <my_array_jobscript></pre>

range is specified in the form X-Y[:Z]  where X is the first index, Y is the upper bound on the indices and Z is the stepping factor.  For example,  2-7:2 will produce indices of 2, 4, and 6. If Z is not specified, it is taken to be 1.

{{Note|text =
<li> Job arrays cannot be interactive</li>
<li> Job arrays are automatically marked as rerunnable</li>
}}

=== Examples ===

==== Examples for PBS options in job scripts ====
<UL>
<li>
You can submit batch jobs using qsub. A very simple qsub script for a MPI job with PBSPro directives (#PBS ...) for the options of qsub looks like this:
<pre>
#!/bin/bash
#
# Simple PBS batch script that reserves two exclusive SandyBridge nodes
# and runs only one MPI process on each node (in total 2 MPI processes)
# The walltime is 10min
#
#PBS -l select=2:node_type=sb:mpiprocs=1
#PBS -l walltime=00:10:00

### go to directory where your job request was submitted 
cd $PBS_O_WORKDIR

### load for example the Intel MPI environment
module load mpi/impi

### run you parallel application on the allocated nodes
mpirun -np 2 ./mpitest
</pre>

{{Warning|text= <BR>
# you have to specify a shell in the first line of your batch script
# you have to specify the number of nodes you need and the node type
# you have to specify the walltime the job needs
# allocated nodes will not be shared with other jobs, even though you uses the nodes only partial
}}
</li>

<BR>
<li>
If you want to use four MPI processes on each node this can be done like this:
<pre>
#!/bin/bash
#
# Simple PBS batch script that reserves two exclusive SandyBridge nodes
#  and runs four MPI process on each node  (in total 8 MPI processes)
# The walltime is 10min
#
#PBS -l select=2:node_type=sb:mpiprocs=4
#PBS -l walltime=00:10:00

### go to directory where your job request was submitted
cd $PBS_O_WORKDIR

### load for example the Intel MPI environment
module load mpi/impi

### run you parallel application on the allocated nodes
mpirun -np 8 ./mpitest
</pre>
</li>

<BR>
<li>
If you need 2h wall time and one node you can use the following script:
<pre>
#!/bin/bash
#
# Simple PBS batch script that runs a scalar job 
# on 1 SandyBridge node using 2h
#
#PBS -l select=1:node_type=sb,walltime=2:00:00
cd $PBS_O_WORKDIR
./my_executable
</pre>
</li>
</UL>

==== Examples for starting batch jobs: ====
<UL>
<li>
Starting a script with all options specified inside the script file
<pre>qsub <script></pre>
</li>

<BR>
<LI>
Starting a script using 3 nodes of node_type 'sb' and a real time of 2 hours:
<pre>qsub -l select=3:node_type=sb,walltime=2:00:00 <script></pre>
</li>

<BR>
<li>
Starting a script using 5 cluster nodes of node_type 'hsw' using 4 processors on each node:
<pre>qsub -l select=5:node_type=hsw:mpiprocs=4,walltime=2:00:00 <script></pre>
</li>

<BR>
<li>
Starting a script using 1 cluster node of type 'hsw' with 256GB memory and additional requesting 5 other 'hsw' nodes (24 cores) with 128GB memory and using 24 MPI processes on each of this 5 nodes;  real job time is 1.5 hours:
<pre>qsub -l select=1:node_type=hsw:node_type_mem=256gb+5:node_type=hsw:node_type_core=24c:node_type_mem=128gb:mpiprocs=24,walltime=1:30:00 <script></pre>
{{Warning|text = 
Because in the first chunk (''1:node_type=hsw:node_type_mem=256gb'') the number of cores for the node isn't specified, it's possible you will get a 20 core hsw node or a 24 core hsw node with 256 GB. 
The second chunk is clearly specified and you will get 5 hsw nodes each will have 128 GB and 20 cores.
}}
</li>

<BR>
<li>
Starting a interactive batch job using 5 hsw nodes regardless how much memory or cores and with a job real time of 300 seconds:
<pre>qsub -I -l select=5:node_type=hsw,walltime=300</pre>
{{Note|text =
For interactive Batch jobs, you don't need a script.sh file. If the requested resources are available, you will get an interactive shell on one of the allocated compute nodes. Which nodes are allocated can be shown with the command 
<pre>cat $PBS_NODEFILE </pre>
on the batch job shell or with the PBS status command 
<pre>qstat -n <jobid></pre> on the master node. 
You can log in from the frontend or any assigned node to all other assigned nodes by 
<pre>ssh <nodename></pre>
If you exit the automatically established interactive shell to the node, it will be assumed that you finished your job and all other connections to the nodes will be terminated.
}}
</li>

<BR>
<li>
Other possibilities to request cluster nodes. You want 4 nodes with a minimum of 16 cores and 32 GB memory each regardless which type of nodes. And you want to run 16 MPI processes on each of the 4 nodes: 
<pre>qsub -l select=4:ncpus=16:mem=32g:mpiprocs=16 <script></pre>
Then its possible you will get a mix of 4 nodes composed of hsw or sb node types with different memory size or core size.

Another possibilty to get explicit hsw nodes:
<pre>qsub -l select=4:node_type=hsw:mem=256g:ncpus=20 <script></pre>
Because the qsub argument 'ncpus=20' requests nodes with at least 20 cores each, its possible you will get available hsw nodes with 20 cores or with 24 cores and with at least 256 GB memory.
</li>

<BR>
<li>
Starting a script which should run on other Account ID: 
 First you have to know which Account ID's (groupnames) are valid for your login:
<pre>id</pre>
Choose a valid groupname for your job (abc12345 will serve as a placeholder here):
<pre>qsub -l select=5:node_type=sb,walltime=300 -W group_list=abc12345</pre>
</li>
</UL>

== Get the batch job status ==
<li>
'''Available commands'''
  <ul>
<pre>
qstat [options]
nstat
</pre>
For detailed informations, see man pages:
<pre>
nstat -h
man qstat
man pbsnodes
</pre>
  </ul>

<li>
'''Examples'''
   <ul>
list all batch jobs:
<pre>qstat -a</pre>
lists all batch queues with resource limit settings:
<pre>qstat -q</pre>
lists node information of a batch job ID:
<pre>qstat -n <JOB_ID></pre>
lists detailed information of a batch job ID:
<pre>qstat -f <JOB_ID></pre>
Displays estimated start time for queued jobs
<pre>qstat -T <JOB_ID></pre>
Displays status information for jobs, job arrays, and subjobs:
<pre>qstat -t <JOB_ID></pre>
lists information of the PBS node status:
<pre>
pbsnodes -a
pbsnodes -l
</pre>
gives informatioin of PBS node and job status:
<pre>
nstat
</pre>

== DISPLAY: X11 applications on interactive batch jobs ==

For X11 applications you need to have SSH X11 Forwarding enabled. This is usually activated per default. But to be sure you can set 'ForwardX11 yes' in your $HOME/.ssh/config. 
To have the same DISPLAY of your current session in your batchjob, the qsub command needs the option argument -X.

<pre>
frontend> qsub -q vis -l select=1:node_type=fx5800,walltime=300 -X -I
</pre>

{{Note|text=
<li>DISPLAY variable in submission environment must be set to desired display.</li>
<li>Can be used with interactive jobs only: must be used with -I </li>
<li>Cannot be used with -v DISPLAY</li>
}}


== Queue Policies and Limitations ==
Different job queues are available for efficient resource usage.

In most cases users do not need to declare a job queue with the qsub command. Jobs are sorted to the right class automatically.
In the following the definition for each job queue is given. In general jobs
with a Duration up to <font color=red>'''24 hours''' </font> and half of the available resources can be
submitted.
Some special resources like nodes with graphics or very large memory, (job sharing nodes) are only available for special queues which have to be declared with the qsub command.
For larger jobs or for special job requirements different restrictions are in place respectively you have to consult the project team

=== route (default) ===
If users don't declare a queue on qsub submission, then the jobs default queue will be this. The "route" queue is a routing queue with final destinations for the industrial user jobs and the standard jobs depends on users/groups and the requested resources. The destination queues of "route" for standard jobs (academic users) are:  
<UL>
==== single ====
This queue is available for all single node jobs.
{|border="1" cellpadding="2"
|-
|'''resource'''||'''min'''||'''max''' || '''note'''
|-
|walltime|| || 24 hours ||
|-
|available nodes||  || 1 per job (64 in total) || only single node jobs
|-
|priority|| || || low 
|-
|joblimit|| || 20 per user, 30 per group ||
|}

==== normal ====
This is for all regular parallel jobs using 2 nodes and more.
{|border="1" cellpadding="2"
|-
|'''resource'''||'''min'''||'''max''' || '''note'''
|-
|walltime|| || 24 hours ||
|-
|available nodes|| 2 || 384 per job (425 in total) ||
|-
|priority|| || || normal 
|-
|joblimit|| || 20 per user ||
|}

</UL>

=== test ===
This queue is for tests and development with restricted resources needs. The jobs in this queue are expected to deliver results after very short time. It's forbidden to use this queue for production jobs. Users have to declare this queue with the qsub submission.
{|border="1" cellpadding="2"
|-
|'''resource'''||'''min'''||'''max''' || '''note'''
|-
|walltime|| || 2 hours ||
|-
|available nodes|| || 425 ||
|-
|priority|| || || very high 
|-
|joblimit|| || 1 per user (4 for ALL) ||
|}

=== interactive ===
This queue is also only for batch jobs in [[Batch_System_PBSPro_(laki_%2B_laki2)#Interactive_batch_Mode | interactive batch mode]] which can also be for tests and development. Users can not declare this queue with the qsub submission. But all [[Batch_System_PBSPro_(laki_%2B_laki2)#Interactive_batch_Mode | interactive batch jobs]] will be routed to this queue automatically.
{|border="1" cellpadding="2"
|-
|'''resource'''||'''min'''||'''max''' || '''note'''
|-
|walltime|| || 8 hours ||
|-
|available nodes|| || 32 || only for job in interactive batch mode
|-
|priority|| || || very high 
|-
|joblimit|| || 2 per user ||
|}

=== vis ===
This queue is only available for jobs using graphic nodes. It can also be used in interactive batch mode.
Only the nodes with a graphic card installed are available with this queue. Users have to declare this queue with the qsub job submission. 
{|border="1" cellpadding="2"
|-
|'''resource'''||'''min'''||'''max''' || '''note'''
|-
|walltime|| || 10 hours ||
|-
|available nodes|| || 1 per job (4 in total) || only nodes with graphic cards
|-
|priority|| || || high 
|-
|joblimit|| || 2 per user, 4 per group ||
|}




=== Job Run Limitations ===

*'''The maximum time limit for a Job is 24hours.'''
* User limits:
** limited number of jobs of one user that can run at the same time
** in total a user can only allocate 384 nodes (it depends on the requested wall time).
* User Group limits:
** limited number of jobs of users in the same group that can run at the same time
* Batch Queue limits of all user jobs:
** not all nodes / node types are available on each queue (visualisation nodes can not be used in multi node job queues)