toil.batchSystems.registry

Module Contents

Functions

aws_batch_batch_system_factory()

gridengine_batch_system_factory()

parasol_batch_system_factory()

lsf_batch_system_factory()

single_machine_batch_system_factory()

mesos_batch_system_factory()

slurm_batch_system_factory()

tes_batch_system_factory()

torque_batch_system_factory()

htcondor_batch_system_factory()

kubernetes_batch_system_factory()

addBatchSystemFactory(key, batchSystemFactory)

Adds a batch system to the registry for workflow-supplied batch systems.

save_batch_system_plugin_state()

Return a snapshot of the plugin registry that can be restored to remove

restore_batch_system_plugin_state(snapshot)

Restore the batch system registry state to a snapshot from

Attributes

logger

BATCH_SYSTEM_FACTORY_REGISTRY

BATCH_SYSTEMS

DEFAULT_BATCH_SYSTEM

toil.batchSystems.registry.logger
toil.batchSystems.registry.aws_batch_batch_system_factory()[source]
toil.batchSystems.registry.gridengine_batch_system_factory()[source]
toil.batchSystems.registry.parasol_batch_system_factory()[source]
toil.batchSystems.registry.lsf_batch_system_factory()[source]
toil.batchSystems.registry.single_machine_batch_system_factory()[source]
toil.batchSystems.registry.mesos_batch_system_factory()[source]
toil.batchSystems.registry.slurm_batch_system_factory()[source]
toil.batchSystems.registry.tes_batch_system_factory()[source]
toil.batchSystems.registry.torque_batch_system_factory()[source]
toil.batchSystems.registry.htcondor_batch_system_factory()[source]
toil.batchSystems.registry.kubernetes_batch_system_factory()[source]
toil.batchSystems.registry.BATCH_SYSTEM_FACTORY_REGISTRY: Dict[str, Callable[[], Type[toil.batchSystems.abstractBatchSystem.AbstractBatchSystem]]]
toil.batchSystems.registry.BATCH_SYSTEMS
toil.batchSystems.registry.DEFAULT_BATCH_SYSTEM = 'single_machine'
toil.batchSystems.registry.addBatchSystemFactory(key, batchSystemFactory)[source]

Adds a batch system to the registry for workflow-supplied batch systems.

Parameters
toil.batchSystems.registry.save_batch_system_plugin_state()[source]

Return a snapshot of the plugin registry that can be restored to remove added plugins. Useful for testing the plugin system in-process with other tests.

Return type

Tuple[List[str], Dict[str, Callable[[], Type[toil.batchSystems.abstractBatchSystem.AbstractBatchSystem]]]]

toil.batchSystems.registry.restore_batch_system_plugin_state(snapshot)[source]

Restore the batch system registry state to a snapshot from save_batch_system_plugin_state().

Parameters

snapshot (Tuple[List[str], Dict[str, Callable[[], Type[toil.batchSystems.abstractBatchSystem.AbstractBatchSystem]]]]) –