# Ewoks: ESRF Workflow System
Many [workflow management systems](https://s.apache.org/existing-workflow-systems) exist to deal with data processing problems that can be expressed as a graph of tasks, also referred to as a *computational graph* or *workflow*. The main purpose of a workflow management system is to provide a framework for implementing tasks, creating graphs of tasks and executing these graphs.
The purpose of *ewoks* is to provide an abstraction layer between graph representation and execution. This allows using the same tasks and graphs in different workflow management systems. *ewoks* itself is **not** a workflow management system.
## Install
```bash
pip install ewoks[orange,dask,ppf,test]
```
## Test
```bash
pytest --pyargs ewoks.tests
```
## Getting started
Workflows can be executed from the command line
```bash
ewoks execute /path/to/graph.json [--engine dask]
```
or for an installation with the system python
```bash
python3 -m ewoks execute /path/to/graph.json [--engine dask]
```
Workflows can also be executed from python
```python
from ewoks import execute_graph
result = execute_graph("/path/to/graph.json", engine="dask")
```
When no engine is specified it will use sequential execution from `ewokscore`.
## Documentation
https://ewoks.readthedocs.io/
Raw data
{
"_id": null,
"home_page": "https://gitlab.esrf.fr/workflow/ewoks/ewoks/",
"name": "ewoks",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "ESRF",
"author_email": "wout.de_nolf@esrf.fr",
"download_url": "https://files.pythonhosted.org/packages/2f/5d/0798c73445706a23441f02691dd887389c96314a72aaa811d48685c72afb/ewoks-0.4.3.tar.gz",
"platform": null,
"description": "# Ewoks: ESRF Workflow System\n\nMany [workflow management systems](https://s.apache.org/existing-workflow-systems) exist to deal with data processing problems that can be expressed as a graph of tasks, also referred to as a *computational graph* or *workflow*. The main purpose of a workflow management system is to provide a framework for implementing tasks, creating graphs of tasks and executing these graphs.\n\nThe purpose of *ewoks* is to provide an abstraction layer between graph representation and execution. This allows using the same tasks and graphs in different workflow management systems. *ewoks* itself is **not** a workflow management system.\n\n## Install\n\n```bash\npip install ewoks[orange,dask,ppf,test]\n```\n\n## Test\n\n```bash\npytest --pyargs ewoks.tests\n```\n\n## Getting started\n\nWorkflows can be executed from the command line\n\n```bash\newoks execute /path/to/graph.json [--engine dask]\n```\n\nor for an installation with the system python\n\n```bash\npython3 -m ewoks execute /path/to/graph.json [--engine dask]\n```\n\nWorkflows can also be executed from python\n\n```python\nfrom ewoks import execute_graph\n\nresult = execute_graph(\"/path/to/graph.json\", engine=\"dask\")\n```\n\nWhen no engine is specified it will use sequential execution from `ewokscore`.\n\n## Documentation\n\nhttps://ewoks.readthedocs.io/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "ESRF Workflow System",
"version": "0.4.3",
"project_urls": {
"Documentation": "https://ewoks.readthedocs.io/",
"Homepage": "https://gitlab.esrf.fr/workflow/ewoks/ewoks/",
"Source": "https://gitlab.esrf.fr/workflow/ewoks/ewoks/",
"Tracker": "https://gitlab.esrf.fr/workflow/ewoks/ewoks/issues/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2f5d0798c73445706a23441f02691dd887389c96314a72aaa811d48685c72afb",
"md5": "37e0a4e9c62d4198cacd54e4add39937",
"sha256": "e08cd4ff6e43f2599150ad6ade0d4628552035c49b2fc91f2d6b1fabf470a0c0"
},
"downloads": -1,
"filename": "ewoks-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "37e0a4e9c62d4198cacd54e4add39937",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 12900,
"upload_time": "2024-02-13T23:45:46",
"upload_time_iso_8601": "2024-02-13T23:45:46.151688Z",
"url": "https://files.pythonhosted.org/packages/2f/5d/0798c73445706a23441f02691dd887389c96314a72aaa811d48685c72afb/ewoks-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-13 23:45:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ewoks"
}
JSON