idmtools_platform_slurm.utils.slurm_job package¶

idmtools SlurmPlatform SlurmJob utils.

idmtools_platform_slurm.utils.slurm_job.create_slurm_indicator() → NoReturn[source]¶: Add environment variable. :returns: None

idmtools_platform_slurm.utils.slurm_job.remove_slurm_indicator() → NoReturn[source]¶: Remove the environment variable. :returns: None

idmtools_platform_slurm.utils.slurm_job.check_slurm_indicator() → bool[source]¶: Check if the environment set to ‘1’. :returns: True/False

idmtools_platform_slurm.utils.slurm_job.slurm_installed() → bool[source]¶: Check if Slurm system is installed or available. :returns: True/False

idmtools_platform_slurm.utils.slurm_job.run_script_on_slurm(platform: SlurmPlatform, run_on_slurm: bool = False, cleanup: bool = True) → bool[source]¶

This is a utility tool which wraps the SlurmJob creation and run. :param platform: idmtools Platform :param run_on_slurm: True/False :param cleanup: True/False to delete the generated slurm job related files

Returns:: True/False

idmtools_platform_slurm.utils.slurm_job Submodules¶

idmtools_platform_slurm.utils.slurm_job.slurm_job module
- generate_script()
- SlurmJob