cwltool.mpi

Experimental support for MPI.

Attributes

MpiConfigT

MPIRequirementName

Classes

MpiConfig

Module Contents

cwltool.mpi.MpiConfigT
cwltool.mpi.MPIRequirementName = 'http://commonwl.org/cwltool#MPIRequirement'
class cwltool.mpi.MpiConfig(runner='mpirun', nproc_flag='-n', default_nproc=1, extra_flags=None, env_pass=None, env_pass_regex=None, env_set=None)
Parameters:
  • runner (str)

  • nproc_flag (str)

  • default_nproc (Union[int, str])

  • extra_flags (Optional[List[str]])

  • env_pass (Optional[List[str]])

  • env_pass_regex (Optional[List[str]])

  • env_set (Optional[Mapping[str, str]])

classmethod load(config_file_name)

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).

Parameters:

config_file_name (str)

Return type:

MpiConfigT

pass_through_env_vars(env)

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

Parameters:

env (MutableMapping[str, str])

Return type:

None

set_env_vars(env)

Set some variables to the value configured.

Parameters:

env (MutableMapping[str, str])

Return type:

None