idmtools_platform_slurm.platform_operations.suite_operations module¶
Here we implement the SlurmPlatform suite operations.
Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
- class idmtools_platform_slurm.platform_operations.suite_operations.SlurmPlatformSuiteOperations(platform: SlurmPlatform, platform_type: ~typing.Type = <class 'idmtools_platform_slurm.platform_operations.utils.SlurmSuite'>)¶
Bases:
IPlatformSuiteOperationsProvides Suite operation to the SlurmPlatform.
- platform: SlurmPlatform¶
- platform_type¶
alias of
SlurmSuite
- get(suite_id: Union[str, UUID], **kwargs) Dict¶
Get a suite from the Slurm platform. :param suite_id: Suite id :param kwargs: keyword arguments used to expand functionality
- Returns:
Slurm Suite object
- platform_create(suite: Suite, **kwargs) Tuple¶
Create suite on Slurm Platform. :param suite: idmtools suite :param kwargs: keyword arguments used to expand functionality
- Returns:
Slurm Suite object created
- platform_run_item(suite: Suite, **kwargs)¶
Called during commissioning of an item. This should perform what is needed to commission job on platform. :param suite:
- Returns:
None
- get_parent(suite: SlurmSuite, **kwargs) Any¶
Fetches the parent of a suite. :param suite: Slurm suite :param kwargs: keyword arguments used to expand functionality
- Returns:
None
- get_children(suite: SlurmSuite, parent: Optional[Suite] = None, raw=True, **kwargs) List[Any]¶
Fetch Slurm suite’s children. :param suite: Slurm suite :param raw: True/False :param parent: the parent of the experiments :param kwargs: keyword arguments used to expand functionality
- Returns:
List of Slurm experiments
- to_entity(slurm_suite: SlurmSuite, children: bool = True, **kwargs) Suite¶
Convert a SlurmSuite object to idmtools Suite. :param slurm_suite: simulation to convert :param children: bool True/False :param kwargs: keyword arguments used to expand functionality
- Returns:
Suite object