.. _execute_python:

Execute a workflow from Python
==============================

Install requirements

.. code-block:: bash

    pip install ewoks

Execute a workflow

.. code-block:: python

    from ewoks import execute_graph

    result = execute_graph("/path/to/graph.json", engine=None)

The :ref:`hello world <hello_world>` example provides a small but complete example of
task implementation, workflow definition and workflow execution.

The *engine* argument can be

 * *ppf*: required to execute cyclic workflows
 * *dask*: required to parallelize workflow execution (thread, processes, cluster)
 * *orange*: required to execute workflows with a graphical interface

When no *engine* is specified it will use sequential execution in the current process.

Bindings can be installed as follows

.. code-block:: bash

    pip install ewoks[orange,dask,ppf]

For more information see the `ewokscore documentation <https://ewokscore.readthedocs.io/>`_.