idmtools_platform_comps.plugin_info module

idmtools comps platform plugin definition.

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

class idmtools_platform_comps.plugin_info.COMPSPlatformSpecification

Bases: PlatformSpecification

Provide the plugin definition for COMPSPlatform.

__init__()

Constructor.

get_description() → str

Get description.

get(**configuration) → COMPSPlatform

Get COMPSPlatform object with configuration.

example_configuration()

Get example config.

get_type() → Type[COMPSPlatform]

Get COMPSPlatform type.

get_example_urls() → List[str]

Get Comps examples.

get_version() → str

Returns the version of the plugin.

Returns:

Plugin Version

get_configuration_aliases() → Dict[str, Dict]

Provides configuration aliases that exist in COMPS.

class idmtools_platform_comps.plugin_info.SSMTPlatformSpecification

Bases: COMPSPlatformSpecification

Provides the plugic spec for SSMTPlatform.

__init__()

Constructor.

get_description() → str

Provide description of SSMT plugin.

get(**configuration) → SSMTPlatform

Get an instance of SSMTPlatform using the configuration.

example_configuration()

Get example config.

get_type() → Type[SSMTPlatform]

Get SSMT type.

get_example_urls() → List[str]

Get SSMT example urls.

get_version() → str

Returns the version of the plugin.

Returns:

Plugin Version

get_configuration_aliases() → Dict[str, Dict]

Provides configuration aliases that exist in COMPS.