Difference between revisions of "Job submission"

From ScientificComputing
Jump to: navigation, search
 
(44 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
<table style="width: 100%;">
 +
<tr valign=top>
 +
<td style="width: 30%; text-align:left">
 +
< [[Job management with LSF]]
 +
</td>
 +
<td style="width: 35%; text-align:center">
 +
[[Main_Page | Home]]
 +
</td>
 +
<td style="width: 35%; text-align:right">
 +
[[Parallel job submission | Submit a parallel job]] >
 +
</td>
 +
</tr>
 +
</table>
 +
 +
 +
The three ways to access computing resources are
 +
# [[Job_submission#Basic_job_submission|'''Submit a job through command line''']]
 +
# [[Job_submission#Job_script_and_#BSUB_pragmas|'''Submit a job through a job bash script using #BSUB pragmas''']]
 +
# [[Job_submission#Interactive_session_on_a_compute_node|'''Get an interactive session on a compute node''']]
 +
 
== Basic job submission ==
 
== Basic job submission ==
 
A basic BSUB job submission command consists of three parts:
 
A basic BSUB job submission command consists of three parts:
Line 6: Line 26:
 
| style="width: 50px; background: #BFE5D9; text-align: center;"| bsub  
 
| style="width: 50px; background: #BFE5D9; text-align: center;"| bsub  
 
| style="width: 100px; background: #B2D9EA;text-align: center; "| LSF options
 
| style="width: 100px; background: #B2D9EA;text-align: center; "| LSF options
| style="width: 50px; background: #FFBDAF; text-align: center"| job  
+
| style="width: 50px; background: #FFBDAF; text-align: center"| Job
 +
|}
 +
 
 +
where
 +
{| style="color: black;"
 +
|-
 +
| style="width: 50px; background: #BFE5D9; text-align: center;"| bsub ||  &nbsp; is the LSF submit command.
 +
|-
 +
| style="width: 100px; background: #B2D9EA;text-align: center; "| LSF options || &nbsp; are for requesting resources and defining job-related options.
 +
|-
 +
| style="width: 50px; background: #FFBDAF; text-align: center"| Job || &nbsp; is a computing job to be submitted.
 
|}
 
|}
  
# The BSUB executable command
 
# LSF options requesting resources and defining job-related options
 
# A job to be submitted
 
  
 
Here is an example:
 
Here is an example:
Line 17: Line 44:
 
|-
 
|-
 
| style="width: 50px; background: #BFE5D9; text-align: center;"| bsub  
 
| style="width: 50px; background: #BFE5D9; text-align: center;"| bsub  
| style="width: 250px; background: #B2D9EA;text-align: center; "| -n 4 -W 4:00 -R "rusage[mem=4096]"
+
| style="width: 350px; background: #B2D9EA;text-align: center; "| -n 1 -W 4:00 -R "rusage[mem=4096]"
| style="width: 150px; background: #FFBDAF; text-align: center"| "python myscript.py"  
+
| style="width: 200px; background: #FFBDAF; text-align: center"| "python myscript.py"  
 
|}
 
|}
  
=== Job ===
+
When the job is submitted, LSF shows job's information:
 +
$ bsub -n 1 -W 4:00 -R "rusage[mem=4096]" "python myscript.py"
 +
Generic job.
 +
Job <8146539> is submitted to queue <normal.4h>
 +
The output includes
 +
# Job type, e.g., Generic Job, MPI Job or Abaqus Job
 +
# Unique JobID, e.g., 8146539
 +
# The queue, e.g., normal.4h, normal.24h, or normal.120h
 +
 
 +
'''Note''': The '''JobID''' is important for monitoring or reporting issues. It is also integrated in the name of the LSF output file. Please don't delete the LSF output file unless you are sure that the job was running fine.
 +
 
 +
{|style="color: black;"
 +
|-
 +
| style="width: 150px; color: black;background: #FFBDAF; text-align: center"| '''Job'''
 +
|}
 
A job can be one of the following:
 
A job can be one of the following:
{| class="wikitable"
+
{| class="wikitable" | style="background:white;"
 
! Job || Command || Examples of job submission command
 
! Job || Command || Examples of job submission command
 
|-
 
|-
Line 36: Line 77:
 
| piped command || "cmd1 &#124; cmd2"
 
| piped command || "cmd1 &#124; cmd2"
 
|-
 
|-
| a command with I/O redirection, quote || "cmd<in >out" || bsub "du -sk/scratch > du.out"
+
| a command with I/O redirection, quote || "cmd<in >out" || bsub "du -sk /scratch > du.out"
 
|-
 
|-
 
| a here document, passed via "<<" || << EOF ... EOF
 
| a here document, passed via "<<" || << EOF ... EOF
Line 42: Line 83:
 
| a shell script, passed via "<" || < script || bsub < hello.sh
 
| a shell script, passed via "<" || < script || bsub < hello.sh
 
|}
 
|}
Command line advisor
 
  
== Job script ==
+
 
 +
{|style="color: black;"
 +
|-
 +
| style="width: 150px; color: black;background: #B2D9EA; text-align: center"| '''LSF options'''
 +
|}
 +
==== Requesting resources ====
 +
{| class="wikitable" | style="background:white;"
 +
! Resources || Format || Default values
 +
|-
 +
| Maximum run time || -W HH:MM || 04:00 (4h), max. 360h
 +
|-
 +
| Number of processors || -n nprocs  || 1 processor
 +
|-
 +
| Memory || -R "rusage[mem=2048]" || 1024 MB per core
 +
|-
 +
| Local scratch space || -R "rusage[scratch=10000]" || 0 MB
 +
|}
 +
 
 +
It is possible to combine memory and scratch requirements:
 +
 
 +
-R "rusage[mem=2048, scratch=10000]"
 +
 
 +
'''Note''': Unlike memory, the batch system '''does not''' reserve any disk space for this scratch directory by default. If your job is expected to write large amounts of temporary data (say, more than 250 MB) into $TMPDIR — or anywhere in the local /scratch file system — you '''must''' request enough scratch space
 +
 
 +
==== Other LSF options ====
 +
{| class="wikitable" | style="background:white;"
 +
|-
 +
| -o outfile || append job’s standard output to outfile
 +
|-
 +
| -e errfile || append job’s error messages to errfile
 +
|-
 +
| -R "rusage[...]" || advanced resource requirement (memory,...)
 +
|-
 +
| -J jobname || assign a jobname to the job
 +
|-
 +
| -w "depcond" || wait until dependency condition is satisfied
 +
|-
 +
| -Is || submit an interactive job with pseudo-terminal
 +
|-
 +
| -B /-N || send an email when the job begins/ends
 +
|-
 +
| -u user@domain || use this address instead of username@ethz.ch
 +
|}
 +
[https://scicomp.ethz.ch/lsf_submission_line_advisor/ LSF submission line advisor] can assist your to find LSF options you need.
 +
 
 +
== Job script and #BSUB pragmas ==
 +
Create a job script called ''job_script.bsub''
 +
 
 
  #!/bin/bash
 
  #!/bin/bash
 
  #BSUB -n 24                    # 24 cores
 
  #BSUB -n 24                    # 24 cores
 
  #BSUB -W 8:00                  # 8-hour run-time
 
  #BSUB -W 8:00                  # 8-hour run-time
 
  #BSUB -R "rusage[mem=4000]"    # 4000 MB per core
 
  #BSUB -R "rusage[mem=4000]"    # 4000 MB per core
  cd /path/to/execution/folder
+
#BSUB -J analysis1
  command arg1 arg2
+
#BSUB -o analysis1.out
 +
#BSUB -e analysis1.err
 +
#BSUB -N
 +
 +
source /cluster/apps/local/env2lmod.sh  # Switch to the new software stack
 +
module load gcc/6.3.0 openmpi/4.0.2    # Load modules
 +
  cd /path/to/execution/folder           # Change directory
 +
  mpirun myprogram arg1                  # Execute the program
 +
 
 +
Submit a job
 +
$ bsub < job_script.bsub
 +
 
 +
The options specified on the command line take precedence over the options in the job script.
 +
 
 +
$ bsub -n 36 < job_script.bsub
 +
 
 +
== Interactive session on a compute node ==
 +
To run a quick test or a benchmark, you can request an interactive session on a compute node by using the BSUB option
 +
-I, -Ip or -Is
 +
 
 +
For example:
 +
[jarunanp@eu-login-38 ~]$ bsub -n 4 -W 01:00 -Is bash
 +
Generic job.
 +
Job <161197292> is submitted to queue <normal.4h>.
 +
<<Waiting for dispatch ...>>
 +
<<Starting on eu-ms-001-15>>
 +
[jarunanp@eu-ms-001-15 ~]$
 +
 
 +
== Further reading ==
 +
* [[Using the batch system|User guide: Using the batch system]]
 +
* [[Job arrays]]
 +
* [[Job chaining]]
 +
* [[X11 forwarding batch interactive jobs ]]
 +
* [[Multiple shareholder groups]]
 +
* [[LSF_mini_reference|LSF mini reference]]
  
bsub < job_script.bsub
+
== Helper ==
 +
* [https://scicomp.ethz.ch/lsf_submission_line_advisor/ LSF Submission Line Advisor]
  
== Interactive session ==
 
  
bsub -n 4 -W 4:00 -R "rusage[mem=4096]" -Is bash
+
<table style="width: 100%;">
 +
<tr valign=top>
 +
<td style="width: 30%; text-align:left">
 +
< [[Job management with LSF]]
 +
</td>
 +
<td style="width: 35%; text-align:center">
 +
[[Main_Page | Home]]
 +
</td>
 +
<td style="width: 35%; text-align:right">
 +
[[Parallel job submission | Submit a parallel job]] >
 +
</td>
 +
</tr>
 +
</table>

Latest revision as of 13:06, 8 November 2021

< Job management with LSF

Home

Submit a parallel job >


The three ways to access computing resources are

  1. Submit a job through command line
  2. Submit a job through a job bash script using #BSUB pragmas
  3. Get an interactive session on a compute node

Basic job submission

A basic BSUB job submission command consists of three parts:

bsub LSF options Job

where

bsub   is the LSF submit command.
LSF options   are for requesting resources and defining job-related options.
Job   is a computing job to be submitted.


Here is an example:

bsub -n 1 -W 4:00 -R "rusage[mem=4096]" "python myscript.py"

When the job is submitted, LSF shows job's information:

$ bsub -n 1 -W 4:00 -R "rusage[mem=4096]" "python myscript.py"
Generic job.
Job <8146539> is submitted to queue <normal.4h>

The output includes

  1. Job type, e.g., Generic Job, MPI Job or Abaqus Job
  2. Unique JobID, e.g., 8146539
  3. The queue, e.g., normal.4h, normal.24h, or normal.120h

Note: The JobID is important for monitoring or reporting issues. It is also integrated in the name of the LSF output file. Please don't delete the LSF output file unless you are sure that the job was running fine.

Job

A job can be one of the following:

Job Command Examples of job submission command
a single Linux command cmd
a program with its path /path/to/myprogram bsub ./bin/hello
a command or program with its arguments cmd arg1 arg2 bsub echo hello
multiple commands "cmd1 ; cmd2" bsub "date; pwd; ls -l"
piped command "cmd1 | cmd2"
a command with I/O redirection, quote "cmd<in >out" bsub "du -sk /scratch > du.out"
a here document, passed via "<<" << EOF ... EOF
a shell script, passed via "<" < script bsub < hello.sh


LSF options

Requesting resources

Resources Format Default values
Maximum run time -W HH:MM 04:00 (4h), max. 360h
Number of processors -n nprocs 1 processor
Memory -R "rusage[mem=2048]" 1024 MB per core
Local scratch space -R "rusage[scratch=10000]" 0 MB

It is possible to combine memory and scratch requirements:

-R "rusage[mem=2048, scratch=10000]"

Note: Unlike memory, the batch system does not reserve any disk space for this scratch directory by default. If your job is expected to write large amounts of temporary data (say, more than 250 MB) into $TMPDIR — or anywhere in the local /scratch file system — you must request enough scratch space

Other LSF options

-o outfile append job’s standard output to outfile
-e errfile append job’s error messages to errfile
-R "rusage[...]" advanced resource requirement (memory,...)
-J jobname assign a jobname to the job
-w "depcond" wait until dependency condition is satisfied
-Is submit an interactive job with pseudo-terminal
-B /-N send an email when the job begins/ends
-u user@domain use this address instead of username@ethz.ch

LSF submission line advisor can assist your to find LSF options you need.

Job script and #BSUB pragmas

Create a job script called job_script.bsub

#!/bin/bash
#BSUB -n 24                     # 24 cores
#BSUB -W 8:00                   # 8-hour run-time
#BSUB -R "rusage[mem=4000]"     # 4000 MB per core
#BSUB -J analysis1
#BSUB -o analysis1.out
#BSUB -e analysis1.err
#BSUB -N

source /cluster/apps/local/env2lmod.sh  # Switch to the new software stack
module load gcc/6.3.0 openmpi/4.0.2     # Load modules
cd /path/to/execution/folder            # Change directory
mpirun myprogram arg1                   # Execute the program

Submit a job

$ bsub < job_script.bsub

The options specified on the command line take precedence over the options in the job script.

$ bsub -n 36 < job_script.bsub

Interactive session on a compute node

To run a quick test or a benchmark, you can request an interactive session on a compute node by using the BSUB option

-I, -Ip or -Is

For example:

[jarunanp@eu-login-38 ~]$ bsub -n 4 -W 01:00 -Is bash
Generic job.
Job <161197292> is submitted to queue <normal.4h>.
<<Waiting for dispatch ...>>
<<Starting on eu-ms-001-15>>
[jarunanp@eu-ms-001-15 ~]$

Further reading

Helper


< Job management with LSF

Home

Submit a parallel job >