cwltool.mpi
===========

.. py:module:: cwltool.mpi

.. autoapi-nested-parse::

   Experimental support for MPI.



Attributes
----------

.. autoapisummary::

   cwltool.mpi.MpiConfigT
   cwltool.mpi.MPIRequirementName


Classes
-------

.. autoapisummary::

   cwltool.mpi.MpiConfig


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

.. py:data:: MpiConfigT

.. py:data:: MPIRequirementName
   :value: 'http://commonwl.org/cwltool#MPIRequirement'


.. py:class:: MpiConfig(runner = 'mpirun', nproc_flag = '-n', default_nproc = 1, extra_flags = None, env_pass = None, env_pass_regex = None, env_set = None)

   .. py:attribute:: runner
      :value: 'mpirun'



   .. py:attribute:: nproc_flag
      :value: '-n'



   .. py:attribute:: default_nproc
      :value: 1



   .. py:attribute:: extra_flags
      :value: []



   .. py:attribute:: env_pass
      :value: []



   .. py:attribute:: env_pass_regex
      :value: []



   .. py:attribute:: env_set


   .. py:method:: load(config_file_name)
      :classmethod:


      Create the MpiConfig object from the contents of a YAML file.

      The file must contain exactly one object, whose attributes must
      be in the list allowed in the class initialiser (all are
      optional).



   .. py:method:: pass_through_env_vars(env)

      Take the configured list of environment variables and pass them to the executed process.



   .. py:method:: set_env_vars(env)

      Set some variables to the value configured.