:py:mod:`parameter_sweep.parallel.parallel_manager_factory`
===========================================================

.. py:module:: parameter_sweep.parallel.parallel_manager_factory


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   parameter_sweep.parallel.parallel_manager_factory.create_parallel_manager
   parameter_sweep.parallel.parallel_manager_factory.has_mpi_peer_processes
   parameter_sweep.parallel.parallel_manager_factory.get_mpi_comm_process
   parameter_sweep.parallel.parallel_manager_factory.should_fan_out



.. py:function:: create_parallel_manager(parallel_manager_class=None, **kwargs)

   Create and return an instance of a ParallelManager, based on the libraries available in the
   runtime environment.

   Allows an optional python class to be passed in as parallel_manager_class. If so, this class
   is instantiated and returned rather than checking the local environment.


.. py:function:: has_mpi_peer_processes()

   Returns whether the process was run as part of an MPI group with > 1 processes.


.. py:function:: get_mpi_comm_process()

   Returns mpi comm world


.. py:function:: should_fan_out(number_of_subprocesses)

   Returns whether the manager should fan out the computation to subprocesses. This
   is mutually exclusive with the process running under MPI.