about summary refs log tree commit diff
path: root/nixpkgs/doc/hooks/mpi-check-hook.section.md
diff options
context:
space:
mode:
Diffstat (limited to 'nixpkgs/doc/hooks/mpi-check-hook.section.md')
-rw-r--r--nixpkgs/doc/hooks/mpi-check-hook.section.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/nixpkgs/doc/hooks/mpi-check-hook.section.md b/nixpkgs/doc/hooks/mpi-check-hook.section.md
new file mode 100644
index 000000000000..586ee2cc7c2d
--- /dev/null
+++ b/nixpkgs/doc/hooks/mpi-check-hook.section.md
@@ -0,0 +1,24 @@
+#  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
+  ];
+```
+
+