idmtools_platform_slurm.slurm_operations.local_operations module

Here we implement the SlurmPlatform local operations.

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

class idmtools_platform_slurm.slurm_operations.local_operations.LocalSlurmOperations(platform: 'SlurmPlatform', platform_type: Type = None)

Bases: SlurmOperations

get_directory(item: Union[Suite, Experiment, Simulation]) → Path

Get item’s path. :param item: Suite, Experiment, Simulation

Returns:

item file directory

get_directory_by_id(item_id: str, item_type: ItemType) → Path

Get item’s path. :param item_id: entity id (Suite, Experiment, Simulation) :param item_type: the type of items (Suite, Experiment, Simulation)

Returns:

item file directory

mk_directory(item: Optional[Union[Suite, Experiment, Simulation]] = None, dest: Optional[Union[Path, str]] = None, exist_ok: Optional[bool] = None) → None

Make a new directory. :param item: Suite/Experiment/Simulation :param dest: the folder path :param exist_ok: True/False

Returns:

None

Link files. :param target: the source file path :param link: the file path

Returns:

None

Link directory/files. :param target: the source folder path. :param link: the folder path

Returns:

None

static update_script_mode(script_path: Union[Path, str], mode: int = 511) → None

Change file mode. :param script_path: script path :param mode: permission mode

Returns:

None

make_command_executable(simulation: Simulation) → None

Make simulation command executable :param simulation: idmtools Simulation

Returns:

None

create_batch_file(item: Union[Experiment, Simulation], max_running_jobs: Optional[int] = None, retries: Optional[int] = None, array_batch_size: Optional[int] = None, dependency: bool = True, **kwargs) → None

Create batch file. :param item: the item to build batch file for :param kwargs: keyword arguments used to expand functionality.

Returns:

None

submit_job(item: Union[Experiment, Simulation], **kwargs) → None

Submit a Slurm job. :param item: idmtools Experiment or Simulation :param kwargs: keyword arguments used to expand functionality

Returns:

None

get_simulation_status(sim_id: str, **kwargs) → EntityStatus

Retrieve simulation status. :param sim_id: Simulation ID :param kwargs: keyword arguments used to expand functionality

Returns:

EntityStatus

create_file(file_path: str, content: str) → None

Create a file with given content and file path.

Parameters:

  • file_path – the full path of the file to be created

  • content – file content

Returns:

Nothing

static cancel_job(job_ids: Union[str, List[str]]) → Any

Cancel Slurm job for given job ids. :param job_ids: slurm jobs id

Returns:

Any

get_job_id(item_id: str, item_type: ItemType) → List

Retrieve the job id for item that had been run. :param item_id: id of experiment/simulation :param item_type: ItemType (Experiment or Simulation)

Returns:

List of slurm job ids

__init__(platform: SlurmPlatform, platform_type: Type = None) → None
platform: SlurmPlatform