idmtools_platform_local.local_cli module

idmtools local platform cli interface.

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

class idmtools_platform_local.local_cli.LocalCLI

Bases: IPlatformCLI

Provides the LocalCLI implementation of the common PlatformCLI interface.

get_experiment_status(id: Optional[str], tags: Optional[List[Tuple[str, str]]]) → NoReturn

Get experiment status.

get_simulation_status(id: Optional[str], experiment_id: Optional[str], status: Optional[str], tags: Optional[List[Tuple[str, str]]]) → NoReturn

Get simulation status.

get_platform_information(platform: LocalPlatform) → dict

Get simulation information.

class idmtools_platform_local.local_cli.LocalCLISpecification

Bases: PlatformCLISpecification

Provides plugin spec for LocalCLI.

get(configuration: dict) → LocalCLI

Get CLI using provided configuration.

get_additional_commands() → NoReturn

Load our cli commands.

get_description() → str

Get description of our cli plugin.