mpiCheckPhaseHook: Setting up MPI Check Phase

doc/hooks/mpi-check-hook.section.md

a46820fb15f30502e3a296e8c8a519b660626dc691061592000000030000019f

#  mpiCheckPhaseHook {#setup-hook-mpi-check}


This hook can be used to setup a check phase that
requires running a MPI application. It detects the
used present MPI implementation type and exports
the neceesary environment variables to use
`mpirun` and `mpiexec` in a Nix sandbox.


Example:

```nix
{ mpiCheckPhaseHook, mpi, ... }:
{
  # ...

  nativeCheckInputs = [
    openssh
    mpiCheckPhaseHook
  ];
}
```

Chunks

49631bb1 (1st chunk of `doc/hooks/mpi-check-hook.section.md`)

Title: mpiCheckPhaseHook: Setting up MPI Check Phase

Summary

The `mpiCheckPhaseHook` facilitates the setup of a check phase for projects that need to run MPI (Message Passing Interface) applications. It automatically identifies the MPI implementation being used and configures the environment variables required to use `mpirun` and `mpiexec` within a Nix sandbox environment. An example shows how to include it as a `nativeCheckInput`.