summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorJan Tojnar <jtojnar@gmail.com>2021-01-24 00:09:45 +0100
committerJan Tojnar <jtojnar@gmail.com>2021-01-24 00:09:45 +0100
commit01ee4ea574a426a5d48cd503163233d13bea050d (patch)
tree8ccca2180720717625a6930efb35c11681968910 /doc
parent58752914f4b22a570ff7cba694df86aef20e255a (diff)
parentf1778cd90eea2c3d5dbca3aa55b6351697dad683 (diff)
downloadnixpkgs-01ee4ea574a426a5d48cd503163233d13bea050d.tar
nixpkgs-01ee4ea574a426a5d48cd503163233d13bea050d.tar.gz
nixpkgs-01ee4ea574a426a5d48cd503163233d13bea050d.tar.bz2
nixpkgs-01ee4ea574a426a5d48cd503163233d13bea050d.tar.lz
nixpkgs-01ee4ea574a426a5d48cd503163233d13bea050d.tar.xz
nixpkgs-01ee4ea574a426a5d48cd503163233d13bea050d.tar.zst
nixpkgs-01ee4ea574a426a5d48cd503163233d13bea050d.zip
Merge branch 'master' into staging-next
Diffstat (limited to 'doc')
-rw-r--r--doc/using/overlays.xml35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/using/overlays.xml b/doc/using/overlays.xml
index caacb0a0462..9ffbb4edd98 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>