idmtools_platform_comps.plugin_info module¶

class idmtools_platform_comps.plugin_info.COMPSPlatformSpecification¶

Bases: idmtools.registry.platform_specification.PlatformSpecification

get_description() → str¶

Get a brief description of the plugin and its functionality.

Returns: The plugin description.

get(**configuration) → idmtools_platform_comps.comps_platform.COMPSPlatform ¶

Return a new platform using the passed in configuration.

Parameters: configuration – The INI configuration file to use.
Returns: The new platform.

example_configuration()¶

Example configuration for the platform. This is useful in help or error messages.

Returns:

get_type() → Type[idmtools_platform_comps.comps_platform.COMPSPlatform]¶

get_example_urls() → List[str]¶

Returns a list of URLs that a series of Examples for plugin can be downloaded from

Returns: List of urls

get_version() → str¶

Returns the version of the plugin

Returns: Plugin Version

get_configuration_aliases() → Dict[str, Dict]¶

Get a list of configuration aliases for the platform.

A configuration alias should be in the form of “name” -> “Spec, Config Options Dict” where name is the alias the user will use, and the config options is a dictionary of config options to be passed to the item Returns:

class idmtools_platform_comps.plugin_info.SSMTPlatformSpecification¶