idmtools_platform_local.internals.ui.controllers.simulations module

idmtools local platform simulations controller(API).

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

idmtools_platform_local.internals.ui.controllers.simulations.sim_status(simulation_id: Optional[str], experiment_id: Optional[str], status: Optional[str], tags: Optional[List[Tuple[str, str]]], page: int = 1, per_page: int = 20) → Tuple[Dict, int]

List of statuses for simulation(s) with the ability to filter by id, experiment_id, status, and tags.

Parameters:

• simulation_id (Optional[str]) – Optional Id of simulation

• experiment_id (Optional[str]) – Optional experiment id

• status (Optional[str]) – Optional status string to filter by

• tags (Optional[List[Tuple[str, str]]]) – Optional list of tuples in form of tag_name tag_value to user to filter experiments with

• page (int) – Which page to load. Defaults to 1

• per_page (int) – Simulations per page. Defaults to 50

Returns:

None

class idmtools_platform_local.internals.ui.controllers.simulations.Simulations

Bases: Resource

Simulation API controller.

get(id=None)

Get simulation.

put(id)

Update simulation.

endpoint = 'simulations'

mediatypes()

methods: ClassVar[Optional[Collection[str]]] = {'GET', 'PUT'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.