Metadata-Version: 2.2
Name: ewokscore
Version: 0.15.0
Summary: API for graphs and tasks in Ewoks
Home-page: https://gitlab.esrf.fr/workflow/ewoks/ewokscore/
Author: ESRF
Author-email: wout.de_nolf@esrf.fr
License: MIT
Project-URL: Source, https://gitlab.esrf.fr/workflow/ewoks/ewokscore/
Project-URL: Documentation, https://ewokscore.readthedocs.io/
Project-URL: Tracker, https://gitlab.esrf.fr/workflow/ewoks/ewokscore/issues/
Keywords: ewoks
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy>=1.15
Requires-Dist: networkx>=2
Requires-Dist: silx>=1
Requires-Dist: pyyaml>=5.1
Requires-Dist: h5py>=2.8
Requires-Dist: packaging
Requires-Dist: ewoksutils>=0.1.2
Requires-Dist: importlib_metadata; python_version < "3.9"
Provides-Extra: notebooks
Requires-Dist: papermill; extra == "notebooks"
Provides-Extra: test
Requires-Dist: ipykernel; extra == "test"
Requires-Dist: matplotlib>=3; extra == "test"
Requires-Dist: papermill; extra == "test"
Requires-Dist: pytest>=7; extra == "test"
Provides-Extra: dev
Requires-Dist: black[jupyter]>=22; extra == "dev"
Requires-Dist: flake8>=4; extra == "dev"
Requires-Dist: flake8_nb>=0.3.1; extra == "dev"
Requires-Dist: ipykernel; extra == "dev"
Requires-Dist: matplotlib>=3; extra == "dev"
Requires-Dist: papermill; extra == "dev"
Requires-Dist: pytest>=7; extra == "dev"
Provides-Extra: doc
Requires-Dist: docutils<0.21; extra == "doc"
Requires-Dist: ipykernel; extra == "doc"
Requires-Dist: matplotlib>=3; extra == "doc"
Requires-Dist: nbsphinx; extra == "doc"
Requires-Dist: nbsphinx_link; extra == "doc"
Requires-Dist: papermill; extra == "doc"
Requires-Dist: pydata-sphinx-theme; extra == "doc"
Requires-Dist: pytest>=7; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints>=1.16; extra == "doc"
Requires-Dist: sphinx>=4.5; extra == "doc"
Requires-Dist: sphinxcontrib-mermaid>=0.7; extra == "doc"

# ewokscore

*ewokscore* provides an API to define workflows and implement tasks in [ewoks](https://ewoks.readthedocs.io/).

## Install

```bash
pip install ewokscore[test]
```

## Test

```bash
pytest --pyargs ewokscore.tests
```

## Getting started

```python
from ewokscore import Task
from ewokscore import execute_graph


# Implement a workflow task
class SumTask(
    Task, input_names=["a"], optional_input_names=["b"], output_names=["result"]
):
    def run(self):
        result = self.inputs.a
        if self.inputs.b:
            result += self.inputs.b
        self.outputs.result = result


# Define a workflow with default inputs
nodes = [
    {
        "id": "task1",
        "task_type": "class",
        "task_identifier": "__main__.SumTask",
        "default_inputs": [{"name": "a", "value": 1}],
    },
    {
        "id": "task2",
        "task_type": "class",
        "task_identifier": "__main__.SumTask",
        "default_inputs": [{"name": "b", "value": 1}],
    },
    {
        "id": "task3",
        "task_type": "class",
        "task_identifier": "__main__.SumTask",
        "default_inputs": [{"name": "b", "value": 1}],
    },
]
links = [
    {
        "source": "task1",
        "target": "task2",
        "data_mapping": [{"source_output": "result", "target_input": "a"}],
    },
    {
        "source": "task2",
        "target": "task3",
        "data_mapping": [{"source_output": "result", "target_input": "a"}],
    },
]
workflow = {"graph": {"id": "testworkflow"}, "nodes": nodes, "links": links}

# Define task inputs
inputs = [{"id": "task1", "name": "a", "value": 10}]

# Execute a workflow (use a proper Ewoks task scheduler in production)
varinfo = {"root_uri": "/tmp/myresults"}  # optionally save all task outputs
result = execute_graph(workflow, varinfo=varinfo, inputs=inputs)
print(result)
```

## Documentation

https://ewokscore.readthedocs.io/
