idmtools_platform_local.platform_operations.experiment_operations module¶

idmtools local platform experiment operations.

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

Bases: IPlatformExperimentOperations

Provide Experiment operation for the LocalPlatform.

platform: LocalPlatform¶

platform_type¶: alias of ExperimentDict

get(experiment_id: UUID, **kwargs) → ExperimentDict¶

Get the experiment object by id.

Parameters:

experiment_id – Id
**kwargs –

Returns:

Experiment Dict object

platform_create(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[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:

None

platform_run_item(experiment: Experiment, **kwargs)¶

Run the experiment.

Parameters:: experiment – experiment to run
Returns:: None

send_assets(experiment: Experiment, **kwargs)¶

Sends assets for specified experiment.

Parameters:: experiment – Experiment to send assets for
Returns:: None

refresh_status(experiment: Experiment, **kwargs)¶

Refresh status of experiment.

Parameters:: experiment – Experiment to refresh status for
Returns:: None

static from_experiment(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) → Experiment¶

Convert an ExperimentDict to an Experiment.

Parameters:

experiment – Experiment to convert
**kwargs –

Returns:

object as an IExperiment object

list_assets(experiment: Experiment, **kwargs) → List[Asset]¶

List assets for a sim.

Parameters:: experiment – Experiment object
Returns:: List of assets.

__init__(platform: LocalPlatform, platform_type: type = <class 'idmtools_platform_local.platform_operations.utils.ExperimentDict'>) → None¶