idmtools_platform_local.platform_operations.experiment_operations module¶

class idmtools_platform_local.platform_operations.experiment_operations.LocalPlatformExperimentOperations(platform: 'LocalPlatform', platform_type: type = <class 'idmtools_platform_local.platform_operations.uitils.ExperimentDict'>)¶

Bases: idmtools.entities.iplatform_ops.iplatform_experiment_operations.IPlatformExperimentOperations

platform: LocalPlatform¶

platform_type¶: alias of idmtools_platform_local.platform_operations.uitils.ExperimentDict

get(experiment_id: uuid.UUID, **kwargs) → idmtools_platform_local.platform_operations.uitils.ExperimentDict ¶

Get the experiment object by id

Parameters

experiment_id – Id
**kwargs –

Returns

Experiment Dict object

platform_create(experiment: idmtools.entities.experiment.Experiment, **kwargs) → Dict¶

Create an experiment.

Parameters

experiment – Experiment to create
**kwargs –

Returns

Created experiment object and UUID

get_children(experiment: Dict, **kwargs) → List[idmtools_platform_local.platform_operations.uitils.SimulationDict]¶

Get children for an experiment

Parameters

experiment – Experiment to get chidren for
**kwargs –

Returns

List of simulation dicts

get_parent(experiment: Any, **kwargs) → None¶

Experiment on local platform have no parents so return None

Parameters

experiment –
**kwargs –

Returns:

platform_run_item(experiment: idmtools.entities.experiment.Experiment, **kwargs)¶

Run the experiment

Parameters: experiment – experiment to run

Returns:

send_assets(experiment: idmtools.entities.experiment.Experiment, **kwargs)¶

Sends assets for specified experiment

Parameters: experiment – Experiment to send assets for

Returns:

refresh_status(experiment: idmtools.entities.experiment.Experiment, **kwargs)¶

Refresh status of experiment

Parameters: experiment – Experiment to refresh status for

Returns:

static from_experiment(experiment: idmtools.entities.experiment.Experiment) → Dict¶

Create a experiment dictionary from Experiment object

Parameters: experiment – Experiment object
Returns: Experiment as a local platform dict

to_entity(experiment: Dict, children: bool = True, **kwargs) → idmtools.entities.experiment.Experiment ¶

Convert an ExperimentDict to an Experiment

Parameters

experiment – Experiment to convert
**kwargs –

Returns

object as an IExperiment object

list_assets(experiment: idmtools.entities.experiment.Experiment, **kwargs) → List[idmtools.assets.asset.Asset]¶

List assets for a sim

Parameters: experiment – Experiment object

Returns: