idmtools_platform_local.cli.simulation module¶

idmtools local platform simulation cli commands.

idmtools_platform_local.cli.simulation.prettify_simulation(simulation: Dict[str, Any])[source]¶

Prettifies a JSON Simulation object for printing on a console.

This includes - Making a pretty progress bar - URL-ifying the data paths

Parameters:: simulation – JSON representation of the Experiment(from API)
Returns:: Prettified simulation

idmtools_platform_local.cli.simulation.status(id: str | None, experiment_id: str | None, status: str | None, tags: List[Tuple[str, str]] | None)[source]¶

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

Parameters:

id (Optional[str]) – Optional Id of simulation
experiment_id (Optional[str]) – Optional experiment id
status (Optional[str]) – Optional status string to filter by
tag (Optional[List[Tuple[str, str]]]) – Optional list of tuples in form of tag_name tag_value to user to filter experiments with

Returns:

None