idmtools_platform_local.cli.experiment module

idmtools cli experiment tools.

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

idmtools_platform_local.cli.experiment.prettify_experiment(experiment: Dict[str, Any])

Prettifies a JSON Experiment object for printing on a console.

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

Parameters:

experiment – JSON representation of the Experiment(from API)

Returns:

Prettify experiment

idmtools_platform_local.cli.experiment.status(id: Optional[str], tags: Optional[List[Tuple[str, str]]])

List the status of experiment(s) with the ability to filter by experiment id and tags.

Parameters:

• id (Optional[str]) – Optional ID of the experiment you want 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

idmtools_platform_local.cli.experiment.extra_commands()

This ensures our local platform specific commands are loaded.