Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update MPI docs according to fpm #937 #116

Merged
merged 1 commit into from
Jun 27, 2023
Merged

Update MPI docs according to fpm #937 #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions pages/spec/metapackages.md
View file
Open in desktop
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