idmtools.utils.filter_simulations module

class idmtools.utils.filter_simulations.FilterItem

Bases: object

static filter_item(platform: idmtools.entities.iplatform.IPlatform, item: idmtools.core.interfaces.ientity.IEntity, skip_sims=None, max_simulations: int = None, **kwargs)

Filter simulations from Experiment or Suite, by default it filter status with Succeeded. If user wants to filter by other status, it also can be done, for example:

filter_item(platform, exp, status=EntityStatus.FAILED

If user wants to filter by tags, it also can be done, for example:

filter_item(platform, exp, tags={'Run_Number': '2'})

Parameters

• platform –

• item –

• skip_sims – list of sim ids

• max_simulations –

• kwargs – extra filters

Returns: list of simulation ids

classmethod filter_item_by_id(platform: idmtools.entities.iplatform.IPlatform, item_id: uuid.UUID, item_type: idmtools.core.enums.ItemType = <ItemType.EXPERIMENT: 'Experiment'>, skip_sims=None, max_simulations: int = None, **kwargs)

Filter simulations from Experiment or Suite :param platform: COMPSPlatform :param item_id: Experiment/Suite id :param item_type: Experiment or Suite :param skip_sims: list of sim ids :param max_simulations: #sims to be returned :param kwargs: extra filters

Returns: list of simulation ids