idmtools_platform_local.plugin_info module

idmtools local platform plugin spec.

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

class idmtools_platform_local.plugin_info.LocalPlatformSpecification

Bases: PlatformSpecification

Provide plugin spec for the LocalPlatform.

get_description() → str

Get plugin description.

get(**configuration) → IPlatform

Build our local platform from the passed in configuration object.

We do our import of platform here to avoid any weird import issues on plugin load.

Parameters:

configuration – COnfiguration to use with local platform.

Returns:

Local platform object created.

example_configuration()

Get our example configuration.

get_type() → Type[LocalPlatform]

Get local platform type.

get_version() → str

Returns the version of the plugin.

Returns:

Plugin Version