Skip to content

Commit 4ea232a

Browse files
authored
Update MPI docs according to fpm #937 (#116)
1 parent 855ed9b commit 4ea232a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

pages/spec/metapackages.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,15 @@ Furthermore, MS-MPI is only available in combination with the [MSYS2](https://ww
8080
The MS-MPI installation is looked up through the `MSMPI_BIN` environment variable, by searching for `mpiexec.exe` in the local path, or in the default folder, `C:\Program Files\Microsoft MPI\Bin\`.
8181

8282
MPI applications can be run manually using `mpirun` or `mpiexec`, or directly via fpm using the `fpm run` command. In the latter case, the MPI runner will use the default number of processes on the current node.
83-
To customize the MPI runner command, the `--runner` option should be used, for example:
83+
To customize the MPI runner command, the `--runner` and `--runner-args` options should be used, for example:
8484

8585
```{code-block}
86-
./fpm run --runner=" -np 4"
86+
./fpm run --runner=" sbatch script.sh"
87+
./fpm run --runner-args=" -np 12 -N 2"
8788
```
8889

90+
Note that `--runner` can be used to override the default runner command (`mpiexec` or `mpirun`), while `--runner-args` should be used to pass arguments to the runner itsef, e.g., the number of processes.
91+
8992
Currently verified system configurations are:
9093
- MacOS/x86_64 + GCC + OpenMPI (via brew)
9194
- MacOS/x86_64 + GCC + MPICH (via brew)

0 commit comments

Comments
 (0)