toil.batchSystems.registry¶

Attributes¶

`logger`
`DEFAULT_BATCH_SYSTEM`

`add_batch_system_factory`(key, class_factory)	Adds a batch system to the registry for workflow or plugin-supplied batch systems.
`get_batch_systems`()	Get the names of all the available batch systems.
`get_batch_system`(key)	Get a batch system class by name.
`aws_batch_batch_system_factory`()
`gridengine_batch_system_factory`()
`lsf_batch_system_factory`()
`single_machine_batch_system_factory`()
`mesos_batch_system_factory`()
`slurm_batch_system_factory`()
`torque_batch_system_factory`()
`htcondor_batch_system_factory`()
`kubernetes_batch_system_factory`()

toil.batchSystems.registry.add_batch_system_factory(key, class_factory)[source]¶

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

Parameters:

class_factory (collections.abc.Callable[[], type[toil.batchSystems.abstractBatchSystem.AbstractBatchSystem]]) – A function that returns a batch system class (NOT an instance), which implements toil.batchSystems.abstractBatchSystem.AbstractBatchSystem.
key (str)

toil.batchSystems.registry.get_batch_systems()[source]¶

Get the names of all the available batch systems.

toil.batchSystems.registry.get_batch_system(key)[source]¶

Get a batch system class by name.

Raises:: KeyError if the key is not the name of a batch system, and ImportError if the batch system’s class cannot be loaded.
Parameters:: key (str)
Return type:: type[toil.batchSystems.abstractBatchSystem.AbstractBatchSystem]