Merge pull request #1239 from Libensemble/formatting/openmpi

hyphen in openmpi

Author: jmlarson1

CHANGELOG.rst

@@ -120,7 +120,7 @@ Output changes:
 
 Bug fixes:
 
-* Resolved PETSc/OpenMPI issue (when using the Executor). #1064
+* Resolved PETSc/Open-MPI issue (when using the Executor). #1064
 * Prevent `mpi4py` validation running during local comms (when using OO interface). #1065
 
 Performance changes:
@@ -380,7 +380,7 @@ Documentation:
 
 :Known issues:
 
-* OpenMPI does not work with direct MPI job launches in ``mpi4py`` comms mode,
+* Open-MPI does not work with direct MPI job launches in ``mpi4py`` comms mode,
   since it does not support nested MPI launches.
   (Either use local mode or the Balsam Executor.)
 * See known issues section in the documentation for more issues.
@@ -444,7 +444,7 @@ Other functionality changes:
 
 :Known issues:
 
-* OpenMPI does not work with direct MPI job launches in ``mpi4py`` comms mode,
+* Open-MPI does not work with direct MPI job launches in ``mpi4py`` comms mode,
   since it does not support nested MPI launches.
   (Either use local mode or the Balsam Executor.)
 * See known issues section in the documentation for more issues.
@@ -492,7 +492,7 @@ Documentation:
 
 :Known issues:
 
-* OpenMPI does not work with direct MPI job launches in ``mpi4py`` comms mode, since it does not support nested MPI launches
+* Open-MPI does not work with direct MPI job launches in ``mpi4py`` comms mode, since it does not support nested MPI launches
   (Either use local mode or Balsam Executor).
 * See known issues section in the documentation for more issues.
 
@@ -540,7 +540,7 @@ Documentation:
 :Known issues:
 
 * We currently recommend running in Central mode on Bridges, as distributed runs are experiencing hangs.
-* OpenMPI does not work with direct MPI job launches in mpi4py comms mode, since it does not support nested MPI launches
+* Open-MPI does not work with direct MPI job launches in mpi4py comms mode, since it does not support nested MPI launches
   (Either use local mode or Balsam Executor).
 * See known issues section in the documentation for more issues.
 
@@ -696,7 +696,7 @@ Release 0.5.0
 
 :Known issues:
 
-* OpenMPI does not work with direct MPI job launches in mpi4py comms mode, since it does not support nested MPI launches
+* Open-MPI does not work with direct MPI job launches in mpi4py comms mode, since it does not support nested MPI launches
   (Either use local mode or Balsam job controller).
 * Local comms mode (multiprocessing) may fail if MPI is initialized before forking processors. This is thought to be responsible for issues combining with PETSc.
 * Remote detection of logical cores via LSB_HOSTS (e.g., Summit) returns number of physical cores since SMT info not available.
@@ -728,7 +728,7 @@ Release 0.4.0
 
 :Known issues:
 
-* OpenMPI is not supported with direct MPI launches since nested MPI launches are not supported.
+* Open-MPI is not supported with direct MPI launches since nested MPI launches are not supported.
 
 Release 0.3.0
 -------------
@@ -749,7 +749,7 @@ Release 0.3.0
 
 :Known issues:
 
-* OpenMPI is not supported with direct MPI launches since nested MPI launches are not supported.
+* Open-MPI is not supported with direct MPI launches since nested MPI launches are not supported.
 
 Release 0.2.0
 -------------
@@ -765,7 +765,7 @@ Release 0.2.0
 :Known issues:
 
 * Killing MPI jobs does not work correctly on some systems (including Cray XC40 and CS400). In these cases, libEnsemble continues, but processes remain running.
-* OpenMPI does not work correctly with direct launches (and has not been tested with Balsam).
+* Open-MPI does not work correctly with direct launches (and has not been tested with Balsam).
 
 Release 0.1.0
 -------------

docs/known_issues.rst

@@ -13,8 +13,8 @@ may occur when using libEnsemble.
   ``srun: error: CPU binding outside of job step allocation, allocated`` in
   the application's standard error. This is being investigated. If this happens
   we recommend using ``local`` comms in place of ``mpi4py``.
-* When using the Executor: OpenMPI does not work with direct MPI task
-  submissions in mpi4py comms mode, since OpenMPI does not support nested MPI
+* When using the Executor: Open-MPI does not work with direct MPI task
+  submissions in mpi4py comms mode, since Open-MPI does not support nested MPI
   executions. Use either ``local`` mode or the Balsam Executor instead.
 * Local comms mode (multiprocessing) may fail if MPI is initialized before
   forking processors. This is thought to be responsible for issues combining

docs/platforms/improv.rst

@@ -61,11 +61,11 @@ Now run forces with five workers (one for generator and four for simulations)::
 mpi4py comms
 ============
 
-You can install mpi4py as usual having installed the openmpi module::
+You can install mpi4py as usual having installed the Open-MPI module::
 
     pip install mpi4py
 
-Note if using ``mpi4py`` comms with openmpi, you may need to set ``export OMPI_MCA_coll_hcoll_enable=0``
+Note if using ``mpi4py`` comms with Open-MPI, you may need to set ``export OMPI_MCA_coll_hcoll_enable=0``
 to prevent HCOLL warnings.
 
 .. _Improv: https://www.lcrc.anl.gov/for-users/using-lcrc/running-jobs/running-jobs-on-improv/

libensemble/executors/mpi_runner.py

@@ -364,7 +364,7 @@ def express_spec(self, task, nprocs, nnodes, ppn, machinefile, hyperthreads, ext
         """
         hostlist = None
         machinefile = None
-        # Use machine files for OpenMPI
+        # Use machine files for Open-MPI
         # as "-host" requires entry for every rank
 
         machinefile = "machinefile_autogen"

libensemble/tests/regression_tests/test_with_app_persistent_aposmm_tao_nm.py

@@ -2,7 +2,7 @@
 Runs libEnsemble with APOSMM with a PETSc/TAO local optimizer and using
 the executor to run an application.
 
-This is to test the scenario, where OpenMPI will fail due to nested MPI, if
+This is to test the scenario, where Open-MPI will fail due to nested MPI, if
 PETSc is imported at global level.
 
 Execute via one of the following commands (e.g., 3 workers):
@@ -35,7 +35,7 @@
 from libensemble.sim_funcs.var_resources import multi_points_with_variable_resources as sim_f
 from libensemble.tools import add_unique_random_streams, parse_args
 
-# For OpenMPI the following lines cannot be used, thus allowing PETSc to import.
+# For Open-MPI the following lines cannot be used, thus allowing PETSc to import.
 # import libensemble.gen_funcs
 # libensemble.gen_funcs.rc.aposmm_optimizers = "petsc"