idmtools_platform_comps.ssmt_work_items.work_order module

idmtools WorkOrder classes.

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

class idmtools_platform_comps.ssmt_work_items.work_order.IWorkOrder(WorkItem_Type: str)

Bases: ABC

Base workorder type.

WorkItem_Type: str

__init__(WorkItem_Type: str) → None

class idmtools_platform_comps.ssmt_work_items.work_order.ExecutionDefinition(Command: str, ImageName: str = 'DockerWorker')

Bases: object

Define the execution definition for workorders.

Command: str

ImageName: str = 'DockerWorker'

__init__(Command: str, ImageName: str = 'DockerWorker') → None

class idmtools_platform_comps.ssmt_work_items.work_order.DockerWorkOrder(WorkItem_Type: str = 'DockerWorker', Execution: ~idmtools_platform_comps.ssmt_work_items.work_order.ExecutionDefinition = <factory>)

Bases: IWorkOrder

Define the docker worker.

WorkItem_Type: str = 'DockerWorker'

Execution: ExecutionDefinition

__init__(WorkItem_Type: str = 'DockerWorker', Execution: ~idmtools_platform_comps.ssmt_work_items.work_order.ExecutionDefinition = <factory>) → None

class idmtools_platform_comps.ssmt_work_items.work_order.BuildFlags(section: ~typing.List[str] = <factory>, library: str = 'https://library.sylabs.io', Switches: ~typing.List[str] = <factory>)

Bases: object

Define build flags.

section: List[str]

library: str = 'https://library.sylabs.io'

Switches: List[str]

__init__(section: ~typing.List[str] = <factory>, library: str = 'https://library.sylabs.io', Switches: ~typing.List[str] = <factory>) → None

class idmtools_platform_comps.ssmt_work_items.work_order.BuildDefinition(Type: str = 'singularity', Input: str | None = None, Flags: ~idmtools_platform_comps.ssmt_work_items.work_order.BuildFlags = <factory>)

Bases: object

Define options for build definitions.

Type: str = 'singularity'

Input: str = None

Flags: BuildFlags

__init__(Type: str = 'singularity', Input: str | None = None, Flags: ~idmtools_platform_comps.ssmt_work_items.work_order.BuildFlags = <factory>) → None

class idmtools_platform_comps.ssmt_work_items.work_order.ImageBuilderWorkOrder(WorkItem_Type: str = 'ImageBuilderWorker', Build: str = BuildDefinition(Type='singularity', Input=None, Flags=BuildFlags(section=['all'], library='https://library.sylabs.io', Switches=[])), Output: str = 'image.sif', Tags: ~typing.Dict[str, str] = <factory>, AdditionalMounts: ~typing.List[str] = <factory>, StaticEnvironment: ~typing.Dict[str, str] = <factory>)

Bases: IWorkOrder

Defines our Image Builder service workorder.

WorkItem_Type: str = 'ImageBuilderWorker'

Build: str = BuildDefinition(Type='singularity', Input=None, Flags=BuildFlags(section=['all'], library='https://library.sylabs.io', Switches=[]))

Output: str = 'image.sif'

Tags: Dict[str, str]

AdditionalMounts: List[str]

StaticEnvironment: Dict[str, str]

__init__(WorkItem_Type: str = 'ImageBuilderWorker', Build: str = BuildDefinition(Type='singularity', Input=None, Flags=BuildFlags(section=['all'], library='https://library.sylabs.io', Switches=[])), Output: str = 'image.sif', Tags: ~typing.Dict[str, str] = <factory>, AdditionalMounts: ~typing.List[str] = <factory>, StaticEnvironment: ~typing.Dict[str, str] = <factory>) → None