idmtools_platform_comps.comps_operations.suite_operations module¶
-
class
idmtools_platform_comps.comps_operations.suite_operations.
CompsPlatformSuiteOperations
(platform: 'COMPSPlatform', platform_type: Type = <class 'COMPS.Data.Suite.Suite'>)¶ Bases:
idmtools.entities.iplatform_ops.iplatform_suite_operations.IPlatformSuiteOperations
-
platform
: ‘COMPSPlatform’¶
-
platform_type
¶ alias of
COMPS.Data.Suite.Suite
-
get
(suite_id: uuid.UUID, columns: Optional[List[str]] = None, load_children: Optional[List[str]] = None, query_criteria: Optional[COMPS.Data.QueryCriteria.QueryCriteria] = None, **kwargs) → COMPS.Data.Suite.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: idmtools.entities.suite.Suite, **kwargs) → Tuple[COMPS.Data.Suite.Suite, uuid.UUID]¶ Create suite on COMPS
- Parameters
suite – Suite to create
**kwargs –
- Returns
COMPS Suite object and a UUID
-
get_parent
(suite: COMPS.Data.Suite.Suite, **kwargs) → Any¶ Get parent of suite. We always return None on COMPS
- Parameters
suite –
**kwargs –
- Returns
None
-
get_children
(suite: COMPS.Data.Suite.Suite, **kwargs) → List[Union[COMPS.Data.Experiment.Experiment, COMPS.Data.WorkItem.WorkItem]]¶ Get children for a suite :param suite: Suite to get children for :param **kwargs: Any arguments to pass on to loading functions
- Returns
List of COMPS Experiments/Workitems that are part of the suite
-
refresh_status
(suite: idmtools.entities.suite.Suite, **kwargs)¶ Refresh the status of a suite. On comps, this is done by refreshing all experiments :param suite: Suite to refresh status of :param **kwargs:
Returns:
-
to_entity
(suite: COMPS.Data.Suite.Suite, children: bool = True, **kwargs) → idmtools.entities.suite.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
-