Skip to content

Commit 995a9e7

Browse files
committed
Update parallel launcher docs
1 parent ad7af82 commit 995a9e7

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

docs/config_reference.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -518,8 +518,10 @@ System Partition Configuration
518518
The program will be launched locally.
519519
- ``lrun``: Parallel programs will be launched using `LC Launcher <https://hpc.llnl.gov/training/tutorials/using-lcs-sierra-system#lrun>`__'s ``lrun`` command.
520520
- ``lrun-gpu``: Parallel programs will be launched using `LC Launcher <https://hpc.llnl.gov/training/tutorials/using-lcs-sierra-system#lrun>`__'s ``lrun -M "-gpu"`` command that enables the CUDA-aware Spectrum MPI.
521-
- ``mpirun``: Parallel programs will be launched using the ``mpirun`` command.
522521
- ``mpiexec``: Parallel programs will be launched using the ``mpiexec`` command.
522+
- ``mpirun``: Parallel programs will be launched using the (generic) ``mpirun`` command.
523+
- ``mpirun-intelmpi``: Parallel programs will be launched using the Intel MPI's ``mpirun`` command.
524+
- ``mpirun-openmpi``: Parallel programs will be launched using the OpenMPI's ``mpirun`` command.
523525
- ``pdsh``: Parallel programs will be launched using the ``pdsh`` command. This launcher uses the partition's :attr:`~config.systems.partitions.access` property in order to determine the options to be passed to ``pdsh``.
524526
- ``srun``: Parallel programs will be launched using `Slurm <https://slurm.schedmd.com/srun.html>`__'s ``srun`` command.
525527
- ``srunalloc``: Parallel programs will be launched using `Slurm <https://slurm.schedmd.com/srun.html>`__'s ``srun`` command, but job allocation options will also be emitted.
@@ -542,6 +544,10 @@ System Partition Configuration
542544
- ``upcrun``: Parallel programs will be launched using the `UPC <https://upc.lbl.gov/>`__ ``upcrun`` command.
543545
- ``upcxx-run``: Parallel programs will be launched using the `UPC++ <https://bitbucket.org/berkeleylab/upcxx/wiki/Home>`__ ``upcxx-run`` command.
544546

547+
.. versionadded:: 4.9
548+
549+
The ``mpirun-intelmpi`` and ``mpirun-openmpi`` parallel launchers were added.
550+
545551
.. tip::
546552

547553
.. versionadded:: 4.0.0

reframe/core/launchers/__init__.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,16 @@ class JobLauncher(metaclass=_JobLauncherMeta):
4040
#: invocation. The keys are the variable names and the values are their
4141
#: corresponding values.
4242
#:
43-
#: This is supported by the following launchers:
43+
#: This is supported by the following launchers only:
4444
#:
4545
#: - ``srun``
4646
#: - ``mpirun-openmpi``
4747
#: - ``mpirun-intelmpi``
4848
#:
4949
#: :type: :class:`Dict[str, str]`
5050
#: :default: ``{}``
51+
#:
52+
#: .. versionadded:: 4.9
5153
env_vars = variable(typ.Dict[str, str], value={})
5254

5355
#: Optional modifier of the launcher command.

reframe/core/launchers/mpi.py

+1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ def command(self, job):
5454

5555
return ret
5656

57+
5758
@register_launcher('ibrun')
5859
class IbrunLauncher(JobLauncher):
5960
'''TACC's custom parallel job launcher.'''

0 commit comments

Comments
 (0)