diff options
| author | Markus Kowalewski <markus.kowalewski@gmail.com> | 2021-01-10 22:44:50 +0100 |
|---|---|---|
| committer | Markus Kowalewski <markus.kowalewski@gmail.com> | 2021-01-23 12:15:18 +0100 |
| commit | 72f96278f73dba04bb73fd3dea0943d21e225cf1 (patch) | |
| tree | 74c4352d7e209ff180c4fcd54de34efac31d9dd3 /doc | |
| parent | 68fa960f6a79bb60d0ab0a700c443117382a95e2 (diff) | |
nixpkgs/manual: add a paragraph about MPI switching mechanism
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/using/overlays.xml | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/using/overlays.xml b/doc/using/overlays.xml index caacb0a04622..9ffbb4edd989 100644 --- a/doc/using/overlays.xml +++ b/doc/using/overlays.xml @@ -291,5 +291,40 @@ stdenv.mkDerivation { } </programlisting> </section> + <section xml:id="sec-overlays-alternatives-mpi"> + <title>Switching the MPI implementation</title> + <para> + All programs that are built with + <link xlink:href="https://en.wikipedia.org/wiki/Message_Passing_Interface">MPI</link> + support use the generic attribute <varname>mpi</varname> + as an input. At the moment Nixpkgs natively provides two different + MPI implementations: + <itemizedlist> + <listitem> + <para> + <link xlink:href="https://www.open-mpi.org/">Open MPI</link> + (default), attribute name <varname>openmpi</varname> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://www.mpich.org/">MPICH</link>, + attribute name <varname>mpich</varname> + </para> + </listitem> + </itemizedlist> + </para> + <para> + To provide MPI enabled applications that use <literal>MPICH</literal>, instead + of the default <literal>Open MPI</literal>, simply use the following overlay: + </para> + <programlisting> +self: super: + +{ + mpi = self.mpich; +} + </programlisting> + </section> </section> </chapter> |