idmtools.entities.suite module

class idmtools.entities.suite.Suite(_uid: uuid.UUID = None, _IItem__pre_creation_hooks: List[Callable[[IItem, IPlatform], None]] = <factory>, _IItem__post_creation_hooks: List[Callable[[IItem, IPlatform], None]] = <factory>, 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, _IRunnableEntity__pre_run_hooks: List[Callable[[IRunnableEntity, IPlatform], None]] = <factory>, _IRunnableEntity__post_run_hooks: List[Callable[[IRunnableEntity, IPlatform], None]] = <factory>, name: str = None, experiments: idmtools.core.interfaces.entity_container.EntityContainer = <factory>, description: str = None)

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

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

Parameters

experiments – The child items of this suite.

experiments: idmtools.core.interfaces.entity_container.EntityContainer

item_type: idmtools.core.enums.ItemType = 'Suite'

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(platform: IPlatform)

Called before the actual creation of the entity.

Parameters

platform – Platform item is being created on

Returns:

post_creation(platform: IPlatform)

Post creation hook for object Returns:

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

to_dict() → Dict