Skip to content

Commit

Permalink
Update MPI docs according to fpm #937 (#116)
Browse files Browse the repository at this point in the history
  • Loading branch information
perazz authored Jun 27, 2023
1 parent 855ed9b commit 4ea232a
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions pages/spec/metapackages.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,15 @@ Furthermore, MS-MPI is only available in combination with the [MSYS2](https://ww
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\`.

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.
To customize the MPI runner command, the `--runner` option should be used, for example:
To customize the MPI runner command, the `--runner` and `--runner-args` options should be used, for example:

```{code-block}
./fpm run --runner=" -np 4"
./fpm run --runner=" sbatch script.sh"
./fpm run --runner-args=" -np 12 -N 2"
```

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.

Currently verified system configurations are:
- MacOS/x86_64 + GCC + OpenMPI (via brew)
- MacOS/x86_64 + GCC + MPICH (via brew)
Expand Down

0 comments on commit 4ea232a

Please sign in to comment.