.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "MPIEXEC.SLURM 1"
.TH MPIEXEC.SLURM 1 2024-02-15 "perl v5.38.2" "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 command line arguments for mpiexec (see below), executable is
the name of the executable and pgmargs are command line arguments for the
executable. For example the following command will run the MPI 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 <np\fR>" 4
.IX Item "-n <np>"
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 SMP nodes, only one processor
will be allocated a job. This flag is used to implement multiple level
parallelism with MPI between nodes, and threads within a node, assmuming the
code is set up to do that.
.IP "\fB\-config <config_file\fR>" 4
.IX Item "-config <config_file>"
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 "\-", 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 "#", 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 XX 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