idmtools_platform_comps.comps_operations.suite_operations module¶

idmtools comps suite operations.

class idmtools_platform_comps.comps_operations.suite_operations.CompsPlatformSuiteOperations(platform: COMPSPlatform, platform_type: ~typing.Type = <class 'COMPS.Data.Suite.Suite'>)¶

Bases: IPlatformSuiteOperations

Provides Suite operation to the COMPSPlatform.

platform: COMPSPlatform¶

platform_type¶: alias of Suite

get(suite_id: UUID, columns: Optional[List[str]] = None, load_children: Optional[List[str]] = None, query_criteria: Optional[QueryCriteria] = None, **kwargs) → Suite¶

Get COMPS Suite.

Parameters:

suite_id – Suite id
columns – Optional list of columns. Defaults to id and name
load_children – Optional list of children to load. Defaults to “tags”, “configuration”
query_criteria – Optional query criteria
**kwargs –

Returns:

COMPSSuite

platform_create(suite: Suite, **kwargs) → Tuple[Suite, UUID]¶

Create suite on COMPS.

Parameters:

suite – Suite to create
**kwargs –

Returns:

COMPS Suite object and a UUID

get_parent(suite: Suite, **kwargs) → Any¶

Get parent of suite. We always return None on COMPS.

Parameters:

suite – Suite to get parent of
**kwargs –

Returns:

None

get_children(suite: Suite, **kwargs) → List[Union[Experiment, WorkItem]]¶

Get children for a suite.

Parameters:

suite – Suite to get children for
**kwargs – Any arguments to pass on to loading functions

Returns:

List of COMPS Experiments/Workitems that are part of the suite

refresh_status(suite: Suite, **kwargs)¶

Refresh the status of a suite. On comps, this is done by refreshing all experiments.

Parameters:

suite – Suite to refresh status of
**kwargs –

Returns:

None

to_entity(suite: Suite, children: bool = True, **kwargs) → Suite¶

Convert a COMPS Suite to an IDM Suite.

Parameters:

suite – Suite to Convert
children – When true, load simulations, false otherwise
**kwargs –

Returns:

IDM Suite

__init__(platform: COMPSPlatform, platform_type: ~typing.Type = <class 'COMPS.Data.Suite.Suite'>) → None¶