idmtools_platform_slurm.assets package

SlurmPlatform utilities.

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

idmtools_platform_slurm.assets.generate_batch(platform: SlurmPlatform, experiment: Experiment, max_running_jobs: int | None = None, array_batch_size: int | None = None, dependency: bool | None = None, template: Path | str = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/envs/latest/lib/python3.9/site-packages/idmtools_platform_slurm/assets/batch.sh.jinja2'), **kwargs) None[source]

Generate bash script file batch.sh :param platform: Slurm Platform :param experiment: idmtools Experiment :param max_running_jobs: int, how many allowed to run :param array_size: INT, array size for slurm job :param dependency: bool, determine if Slurm jobs depend on each other :param template: template to be used to build batch file :param kwargs: keyword arguments used to expand functionality

Returns:

None

idmtools_platform_slurm.assets.generate_script(platform: SlurmPlatform, experiment: Experiment, max_running_jobs: int | None = None, template: Path | str = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/envs/latest/lib/python3.9/site-packages/idmtools_platform_slurm/assets/sbatch.sh.jinja2'), **kwargs) None[source]

Generate batch file sbatch.sh :param platform: Slurm Platform :param experiment: idmtools Experiment :param max_running_jobs: int, how many allowed to run at the same time :param template: template to be used to build batch file :param kwargs: keyword arguments used to expand functionality

Returns:

None

idmtools_platform_slurm.assets.generate_simulation_script(platform: SlurmPlatform, simulation, retries: int | None = None) None[source]

Generate batch file _run.sh :param platform: Slurm Platform :param simulation: idmtools Simulation :param retries: int

Returns:

None