idmtools.entities.suite module

class idmtools.entities.suite.Suite(_uid: uuid.UUID = None, platform_id: uuid.UUID = None, _platform: IPlatform = None, parent_id: uuid.UUID = None, _parent: IEntity = None, status: idmtools.core.enums.EntityStatus = None, tags: Dict[str, Any] = <factory>, _platform_object: Any = None, name: str = None, experiments: idmtools.core.interfaces.entity_container.EntityContainer = <factory>, description: str = None)

Bases: idmtools.core.interfaces.inamed_entity.INamedEntity, abc.ABC

Class that represents a generic suite (a collection of experiments).

Parameters

experiments – The child items of this suite.

experiments: EntityContainer
item_type: idmtools.core.enums.ItemType = 1
description: str = None
add_experiment(experiment: Experiment) → NoReturn

Add an experiment to the suite :param experiment: the experiment to be linked to suite

display()
pre_creation()

Called before the actual creation of the entity.

post_creation()

Called after the actual creation of the entity.

property done

Return if an suite has finished executing

Returns

True if all experiments have ran, False otherwise

property succeeded

Return if an suite has succeeded. An suite is succeeded when all experiments have succeeded

Returns

True if all experiments have succeeded, False otherwise

run(wait_until_done: bool = False, platform: IPlatform = None, **run_opts) → NoReturn

Runs an experiment on a platform

Parameters

  • wait_until_done – Whether we should wait on experiment to finish running as well. Defaults to False

  • platform – Platform object to use. If not specified, we first check object for platform object then the

  • context (current) –

  • **run_opts – Options to pass to the platform

Returns

None

wait(timeout: int = None, refresh_interval=None, platform: IPlatform = None)

Wait on an experiment to finish running

Parameters

  • timeout – Timeout to wait

  • refresh_interval – How often to refresh object

  • platform – Platform. If not specified, we try to determine this from context

Returns:

to_dict() → Dict