From db9592901d540035edcf935e9a9748d4438d2938 Mon Sep 17 00:00:00 2001
From: "Peter W. Draper" <p.w.draper@durham.ac.uk>
Date: Tue, 5 May 2020 15:10:52 +0100
Subject: [PATCH] Start documenting MPI settings that can work

---
 README-mpi-hints.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README-mpi-hints.md

diff --git a/README-mpi-hints.md b/README-mpi-hints.md
new file mode 100644
index 0000000000..d5bdc4cfd9
--- /dev/null
+++ b/README-mpi-hints.md
@@ -0,0 +1,38 @@
+Various hints on settings needed to get various MPIs running with SWIFT.
+
+Last update 5th May 2020.
+
+[[_TOC_]]
+
+## Intel MPI
+
+_Intel MPI 2018_ usually runs without any needs for special settings.
+
+_Intel MPI 2019 and 2020_ can run for small tests, but without flags will
+generally deadlock in the MPI exchanges of the engine, or worse. In that case
+try the following settings.
+
+```
+  FI_OFI_RXM_RX_SIZE=4096
+  FI_OFI_RXM_TX_SIZE=4096
+  FI_UNIVERSE_SIZE=2048
+```
+
+If you want use the `release_mt` library, then you also need to use:
+
+```
+  source $I_MPI_ROOT/intel64/bin/mpivars.sh release_mt
+```
+
+when initializing the library environment. Some success has also been seen
+using the asynchronous progression settings:
+
+```
+  I_MPI_ASYNC_PROGRESS=1
+  I_MPI_ASYNC_PROGRESS_THREADS=1
+
+```
+(note these are tested with `2019 update-4` and `2020 update-1`).
+
+## OpenMPI
+
-- 
GitLab