idmtools_platform_comps.comps_operations.suite_operations module

idmtools comps suite operations.

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

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

Bases: IPlatformSuiteOperations

Provides Suite operation to the COMPSPlatform.

platform: COMPSPlatform
platform_type

alias of Suite

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

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][source]

Create suite on COMPS.

Parameters:

  • suite – Suite to create

  • **kwargs –

Returns:

COMPS Suite object and a UUID

get_parent(suite: Suite, **kwargs) → Any[source]

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[Experiment | WorkItem][source]

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)[source]

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[source]

Convert a COMPS Suite to an IDM Suite.

Parameters:

  • suite – Suite to Convert

  • children – When true, load simulations, false otherwise

  • **kwargs –

Returns:

IDM Suite

create_sim_directory_map(suite_id: str) → Dict[source]

Build simulation working directory mapping. :param suite_id: suite id

Returns:

Dict of simulation id as key and working dir as value

platform_delete(suite_id: str) → None[source]

Delete platform suite. :param suite_id: platform suite id

Returns:

None

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