.. _executors:

Executors
=========

.. versionchanged:: 3.0.0
   Executors now work with every built-in backend. Previously, only the Slurm
   backend supported them.

Executors are supported by all built-in backends.

Executors are used to enable runtime behavior for targets. This means that you
can now use executors to run your target inside Conda, Pixi, Apptainer, and
Singularity environments:

.. code-block:: python

   from gwf import Workflow
   from gwf.executors import Conda

   gwf = Workflow()

   gwf.target("Test", inputs=[], outputs=[], executor=Conda("myenv")) <<< """
   echo this will run inside the `myenv` Conda environment.
   """

A default executor can also be specified for the workflow:

.. code-block:: python

   from gwf import Workflow
   from gwf.executors import Conda

   gwf = Workflow(executor=Conda("myenv"))

   gwf.target("Test", inputs=[], outputs=[]) <<< """
   echo this will run inside the `myenv` Conda environment.
   """

Available executors
-------------------

.. automodule:: gwf.executors
   :members:
   :exclude-members: Executor
   :member-order: bysource