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[source]

Bases: IPlatformCLI

Provides the LocalCLI implementation of the common PlatformCLI interface.

get_experiment_status(id: str | None, tags: List[Tuple[str, str]] | None) NoReturn[source]

Get experiment status.

get_simulation_status(id: str | None, experiment_id: str | None, status: str | None, tags: List[Tuple[str, str]] | None) NoReturn[source]

Get simulation status.

get_platform_information(platform: LocalPlatform) dict[source]

Get simulation information.

class idmtools_platform_local.local_cli.LocalCLISpecification[source]

Bases: PlatformCLISpecification

Provides plugin spec for LocalCLI.

get(configuration: dict) LocalCLI[source]

Get CLI using provided configuration.

get_additional_commands() NoReturn[source]

Load our cli commands.

get_description() str[source]

Get description of our cli plugin.