.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "MPIEXEC.SLURM 1" .TH MPIEXEC.SLURM 1 "2022-05-06" "perl v5.32.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" mpiexec.slurm \- Run an MPI program under Slurm .SH "SYNOPSIS" .IX Header "SYNOPSIS" mpiexec.slurm args executable pgmargs .PP where args are comannd line arguments for mpiexec (see below), executable is the name of the eecutable and pgmargs are command line arguments for the executable. For example the following command will run the \s-1MPI\s0 program a.out on 4 processes: .PP .Vb 1 \& mpiexec.slurm \-n 4 a.out .Ve .PP mpiexec.slurm supports the following options: .PP .Vb 10 \& [\-n nprocs] \& [\-host hostname] \& [\-verbose] \& [\-nostdin] \& [\-allstdin] \& [\-nostdout] \& [\-pernode] \& [\-config config_file] \& [\-help|\-?] \& [\-man] .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBmpiexec.slurm\fR .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-n " 4 .IX Item "-n " Specify the number of processes to use .IP "\fB\-host hostname\fR" 4 .IX Item "-host hostname" Name of host on which to run processes .IP "\fB\-verbose\fR" 4 .IX Item "-verbose" Increase the verbosity of mpiexec.slurm informational messages. Multiple \&\-verbose's will further increase mpiexec.slurm's verbosity. By default only errors will be displayed. .IP "\fB\-nostdin\fR" 4 .IX Item "-nostdin" Do not connect the standard input stream of process 0 to the mpiexec process. If the process attempts to read from stdin, it will see an end-of-file. .IP "\fB\-allstdin\fR" 4 .IX Item "-allstdin" Send the standard input stream of mpiexec.slurm to all processes. Each character typed to mpiexec (or read from a file) is duplicated numproc times, and sent to each process. This permits every process to read, for example, configuration information from the input stream. .IP "\fB\-nostdout\fR" 4 .IX Item "-nostdout" Do not connect the standard output and error streams of each process back to the mpiexec.slurm process. Standard output and error will be respectively writte in files of the form job.ojobid and job.ejobid for batch jobs, and directly to the controlling terminal for interactive jobs. .IP "\fB\-pernode\fR" 4 .IX Item "-pernode" Allocate only one process per compute node. For \s-1SMP\s0 nodes, only one processor will be allocated a job. This flag is used to implement multiple level parallelism with \s-1MPI\s0 between nodes, and threads within a node, assmuming the code is set up to do that. .IP "\fB\-config " 4 .IX Item "-config " Process executable and arguments are specified in the given configuration file. This flag permits the use of heterogeneous jobs using multiple executables. No executable is given on the command line when using the \-config flag. If config_file is \*(L"\-\*(R", then the configuration is read from standard input. In this case the flag \-nostdin is mandatory, as it is not possible to separate the contents of the configuration file from process input. The config_file can contain lines beginning with \*(L"#\*(R", that are considered comments and ignored and and one or more lines with the following format: .Sp .Vb 1 \& \-n XX : executable [args] .Ve .Sp where \s-1XX\s0 is the number of processes to be used, executable is the name of the program to run and args are its arguments. For example: .Sp .Vb 5 \& # Sample mpiexec config file \& # Launch two instance of foo \& \-n 2 : foo \& # and three instances of bar \& \-n 3 bar .Ve .Sp There is no support for hostname task layout in a config file at the moment. .IP "\fB\-help|\-?\fR" 4 .IX Item "-help|-?" Display a brief help page