sierra.plugins.hpc.slurm.plugin

HPC plugin for running SIERRA on HPC clusters using the SLURM scheduler.

• ParsedCmdlineConfigurer: Configure SIERRA for SLURM HPC.

• ExpShellCmdsGenerator: Generate the cmd to correctly invoke GNU Parallel on SLURM HPC.

class sierra.plugins.hpc.slurm.plugin.ParsedCmdlineConfigurer(exec_env: str)

Configure SIERRA for SLURM HPC.

Uses the following environment variables (if any of them are not defined an assertion will be triggered):

• SLURM_CPUS_PER_TASK

• SLURM_TASKS_PER_NODE

• SLURM_JOB_NODELIST

• SLURM_JOB_ID

Inheritance

__call__(args: Namespace) → None

Call self as a function.

__dict__ = mappingproxy({'__module__': 'sierra.plugins.hpc.slurm.plugin', '__doc__': 'Configure SIERRA for SLURM HPC.\n\n    Uses the following environment variables (if any of them are not defined an\n    assertion will be triggered):\n\n    - ``SLURM_CPUS_PER_TASK``\n    - ``SLURM_TASKS_PER_NODE``\n    - ``SLURM_JOB_NODELIST``\n    - ``SLURM_JOB_ID``\n\n    ', '__init__': <function ParsedCmdlineConfigurer.__init__>, '__call__': <function ParsedCmdlineConfigurer.__call__>, '__dict__': <attribute '__dict__' of 'ParsedCmdlineConfigurer' objects>, '__weakref__': <attribute '__weakref__' of 'ParsedCmdlineConfigurer' objects>, '__annotations__': {}})

__doc__ = 'Configure SIERRA for SLURM HPC.\n\n    Uses the following environment variables (if any of them are not defined an\n    assertion will be triggered):\n\n    - ``SLURM_CPUS_PER_TASK``\n    - ``SLURM_TASKS_PER_NODE``\n    - ``SLURM_JOB_NODELIST``\n    - ``SLURM_JOB_ID``\n\n    '

__init__(exec_env: str) → None

__module__ = 'sierra.plugins.hpc.slurm.plugin'

__weakref__

list of weak references to the object (if defined)

class sierra.plugins.hpc.slurm.plugin.ExpShellCmdsGenerator(cmdopts: Dict[str, Any], exp_num: int)

Generate the cmd to correctly invoke GNU Parallel on SLURM HPC.

Inheritance

__dict__ = mappingproxy({'__module__': 'sierra.plugins.hpc.slurm.plugin', '__doc__': 'Generate the cmd to correctly invoke GNU Parallel on SLURM HPC.\n\n    ', '__init__': <function ExpShellCmdsGenerator.__init__>, 'pre_exp_cmds': <function ExpShellCmdsGenerator.pre_exp_cmds>, 'post_exp_cmds': <function ExpShellCmdsGenerator.post_exp_cmds>, 'exec_exp_cmds': <function ExpShellCmdsGenerator.exec_exp_cmds>, '__dict__': <attribute '__dict__' of 'ExpShellCmdsGenerator' objects>, '__weakref__': <attribute '__weakref__' of 'ExpShellCmdsGenerator' objects>, '__annotations__': {}})

__doc__ = 'Generate the cmd to correctly invoke GNU Parallel on SLURM HPC.\n\n    '

__init__(cmdopts: Dict[str, Any], exp_num: int) → None

__module__ = 'sierra.plugins.hpc.slurm.plugin'

__weakref__

list of weak references to the object (if defined)

exec_exp_cmds(exec_opts: Dict[str, str]) → List[ShellCmdSpec]

post_exp_cmds() → List[ShellCmdSpec]

pre_exp_cmds() → List[ShellCmdSpec]