add warnings about syncro mode

jcmgray · Nov 3, 2017 · cbaac0d · cbaac0d
1 parent d08a9f1
commit cbaac0d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/bin/quimb-mpi-python b/bin/quimb-mpi-python
@@ -9,7 +9,7 @@ key="$1"
 case $key in
     -h|--help)
     echo "Run a python script that uses quimb, eagerly launching
-    with mpi, rather than dynamically spawning MPI processes.
+with mpi, rather than dynamically spawning MPI processes.
 
     Usage:
         quimb-mpi-python [OPTIONS]... [SCRIPT]...
@@ -27,6 +27,9 @@ case $key in
             a MPIPool is encountered.
         -h, --help
             Show this help.
+
+Note that in syncro mode, *all* functions called outside
+of the mpi pool must be pure to ensure syncronization.
     "
     exit 0
     ;;

diff --git a/docs/distributed parallelism - mpi.rst b/docs/distributed parallelism - mpi.rst
@@ -15,4 +15,4 @@ Modes of execution
 
 .. warning::
 
-    In syncro mode, potentially conflicting operations such as IO should be guarded with ``if MPI.COMM_WORLD.Get_rank() == 0`` etc.
+    In syncro mode, potentially conflicting operations such as IO should be guarded with ``if MPI.COMM_WORLD.Get_rank() == 0`` etc. Additionally, any functions called outside of the MPI pool should be pure to ensure syncronization.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,4 +15,4 @@ Modes of execution

		.. warning::

		In syncro mode, potentially conflicting operations such as IO should be guarded with ``if MPI.COMM_WORLD.Get_rank() == 0`` etc.
		In syncro mode, potentially conflicting operations such as IO should be guarded with ``if MPI.COMM_WORLD.Get_rank() == 0`` etc. Additionally, any functions called outside of the MPI pool should be pure to ensure syncronization.