idmtools_platform_slurm.platform_operations.utils module#

This is SlurmPlatform operations utils.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.

class idmtools_platform_slurm.platform_operations.utils.SlurmItem(metas: Dict)[source]#

Bases: object

Represent Slurm Object

__init__(metas: Dict)[source]#
get_platform_object()[source]#
class idmtools_platform_slurm.platform_operations.utils.SlurmSuite(metas: Dict)[source]#

Bases: SlurmItem

Represent Slurm Suite

__init__(metas: Dict)[source]#
class idmtools_platform_slurm.platform_operations.utils.SlurmExperiment(metas: Dict)[source]#

Bases: SlurmItem

Represent Slurm Experiment

__init__(metas: Dict)[source]#
class idmtools_platform_slurm.platform_operations.utils.SlurmSimulation(metas: Dict)[source]#

Bases: SlurmItem

Represent Slurm Simulation

__init__(metas: Dict)[source]#
idmtools_platform_slurm.platform_operations.utils.clean_experiment_name(experiment_name: str) → str[source]#

Handle some special characters in experiment names. :param experiment_name: name of the experiment

Returns:the experiment name allowed for use

idmtools_platform_slurm.platform_operations.utils.add_dummy_suite(experiment: Experiment, suite_name: str | None = None, tags: Dict | None = None) → Suite[source]#

Create Suite parent for given experiment :param experiment: idmtools Experiment :param suite_name: new Suite name :param tags: new Suite tags

Returns:

Suite

idmtools_platform_slurm.platform_operations.utils.get_max_array_size()[source]#

Get Slurm MaxArraySize from configuration. :returns: Slurm system MaxArraySize

idmtools_platform_slurm.platform_operations.utils.check_home(directory: str) → bool[source]#

Check if a directory is under HOME. :param directory: a directory

Returns:

True/False