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

   1 #  mpiCheckPhaseHook {#setup-hook-mpi-check}
   2
   3
   4 This hook can be used to setup a check phase that
   5 requires running a MPI application. It detects the
   6 used present MPI implementation type and exports
   7 the neceesary environment variables to use
   8 `mpirun` and `mpiexec` in a Nix sandbox.
   9
  10
  11 Example:
  12
  13 ```nix
  14   { mpiCheckPhaseHook, mpi, ... }:
  15   {
  16     # ...
  17
  18     nativeCheckInputs = [
  19       openssh
  20       mpiCheckPhaseHook
  21     ];
  22   }
  23 ```
  24
  25