ewoksppf |release|
==================

*ewoksppf* provides task scheduling for cyclic `ewoks <https://ewoks.readthedocs.io/>`_ workflows.

*ewoksppf* has been developed by the `Software group <http://www.esrf.eu/Instrumentation/software>`_ of the `European Synchrotron <https://www.esrf.eu/>`_.

Getting started
---------------

Install requirements

.. code:: bash

    python3 -m pip install ewoksppf

Execute a workflow

.. code:: python

    from ewoksppf import execute_graph

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

Run the tests

.. code:: bash

    python3 -m pip install ewoksppf[test]
    python3 -m pytest --pyargs ewoksppf.tests

Documentation
-------------

.. toctree::
    :maxdepth: 2

    actors
    api