idmtools_platform_local.client.simulations_client module

idmtools local platform simulations API Client.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.

class idmtools_platform_local.client.simulations_client.SimulationsClient

Bases: BaseClient

Provide API client for Simulations.

path_url = 'simulations'

classmethod get_all(experiment_id: Optional[str] = None, status: Optional[Status] = None, tags: Optional[List[Tuple[str, str]]] = None, page: Optional[int] = None, per_page: Optional[int] = None) → List[Dict[str, Any]]

Get all simulation matcher a criteria.

Parameters:

• experiment_id – ID of the simulation

• status – Optional status

• tags – List of tags/values to filter experiment by

• page – page

• per_page – items per page

Returns:

return list of simulations

Return type:

List[Dict[str, Any]]

classmethod get_one(simulation_id: str, experiment_id: Optional[str] = None, status: Optional[Status] = None, tags: Optional[List[Tuple[str, str]]] = None) → Dict[str, Any]

Get one simulation.

Args:

simulation_id (str): ID of the simulation experiment_id (Optional[str]): ID of experiments status (Optional[Status]): Optional status tags (Optional[List[Tuple[str, str]]]): List of tags/values to filter experiment by

Returns:

the simulation as a dict

Return type:

Dict[str, Any]

classmethod cancel(simulation_id: str) → Dict[str, Any]

Marks a simulation to be canceled. Canceled jobs are only truly canceled when the queue message is processed.

Parameters:

simulation_id (st) –

Returns:

Cancel result