| Name | ewoksjob JSON |
| Version |
1.3.1
JSON |
| download |
| home_page | None |
| Summary | Asynchronous and distributed scheduling of Ewoks workflows from python |
| upload_time | 2025-11-02 18:02:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | # MIT License
**Copyright (c) 2021 European Synchrotron Radiation Facility**
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ewoksjob
Utilities for job scheduling of [ewoks](https://ewoks.readthedocs.io/) workflows.
Ewoksjob provides an ewoks interface for asynchronous and distributed scheduling of [ewoks](https://ewoks.readthedocs.io/) from python.
Note that *ewoksjob* distributes the execution of workflows while [ewoksdask](https://ewoks.readthedocs.io/)
distributes the execution of tasks in a workflow. So in the context of workflows, job scheduling exists on two levels.
The primary clients that need to schedule workflows are
* [Ewoksserver](https://gitlab.esrf.fr/workflow/ewoks/ewoksserver): web backend for ewoks.
* [Bliss](https://gitlab.esrf.fr/bliss/bliss): the ESRF beamline control system.
* [Daiquiri](https://gitlab.esrf.fr/ui/daiquiri): web backend for Bliss.
## Installation
Install on the client side
```bash
pip install ewoksjob
```
Install on the worker side
```bash
pip install ewoksjob[worker]
```
## Getting started
Start a worker pool that can execute ewoks graphs
```bash
ewoksjob worker
```
Submit a workflow on the client side
```python
from ewoksjob.client import submit
workflow = {"graph": {"id": "mygraph"}}
future = submit(args=(workflow,))
result = future.result(timeout=None)
```
Note that both environments need to be able to import `celeryconfig` which
contains celery configuration (mainly the message broker and result backend URL's).
## Hello world example
Clone the git repository and start a worker pool
```bash
scripts/worker.sh --sql
```
Submit workflows
```bash
scripts/runjobs.sh --sql
```
## Tests
```bash
pytest --pyargs ewoksjob
```
To run the redis tests you need `redis-server` (e.g. `conda install redis-server`).
## Documentation
https://ewoksjob.readthedocs.io/
Raw data
{
"_id": null,
"home_page": null,
"name": "ewoksjob",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "ESRF <dau-pydev@esrf.fr>",
"download_url": "https://files.pythonhosted.org/packages/16/8c/6eaf977c5bda56392240adce3c653bd46ac6a3754a10216b8c5040313740/ewoksjob-1.3.1.tar.gz",
"platform": null,
"description": "# ewoksjob\n\nUtilities for job scheduling of [ewoks](https://ewoks.readthedocs.io/) workflows.\n\nEwoksjob provides an ewoks interface for asynchronous and distributed scheduling of [ewoks](https://ewoks.readthedocs.io/) from python.\n\nNote that *ewoksjob* distributes the execution of workflows while [ewoksdask](https://ewoks.readthedocs.io/)\ndistributes the execution of tasks in a workflow. So in the context of workflows, job scheduling exists on two levels.\n\nThe primary clients that need to schedule workflows are\n* [Ewoksserver](https://gitlab.esrf.fr/workflow/ewoks/ewoksserver): web backend for ewoks.\n* [Bliss](https://gitlab.esrf.fr/bliss/bliss): the ESRF beamline control system.\n* [Daiquiri](https://gitlab.esrf.fr/ui/daiquiri): web backend for Bliss.\n\n## Installation\n\nInstall on the client side\n\n```bash\npip install ewoksjob\n```\n\nInstall on the worker side\n\n```bash\npip install ewoksjob[worker]\n```\n\n## Getting started\n\nStart a worker pool that can execute ewoks graphs\n\n```bash\newoksjob worker\n```\n\nSubmit a workflow on the client side\n\n```python\nfrom ewoksjob.client import submit\n\nworkflow = {\"graph\": {\"id\": \"mygraph\"}}\nfuture = submit(args=(workflow,))\nresult = future.result(timeout=None)\n```\n\nNote that both environments need to be able to import `celeryconfig` which\ncontains celery configuration (mainly the message broker and result backend URL's).\n\n## Hello world example\n\nClone the git repository and start a worker pool\n\n```bash\nscripts/worker.sh --sql\n```\n\nSubmit workflows\n\n```bash\nscripts/runjobs.sh --sql\n```\n\n## Tests\n\n```bash\npytest --pyargs ewoksjob\n```\n\nTo run the redis tests you need `redis-server` (e.g. `conda install redis-server`).\n\n## Documentation\n\nhttps://ewoksjob.readthedocs.io/\n",
"bugtrack_url": null,
"license": "# MIT License\n \n **Copyright (c) 2021 European Synchrotron Radiation Facility**\n \n Permission is hereby granted, free of charge, to any person obtaining a copy of\n this software and associated documentation files (the \"Software\"), to deal in\n the Software without restriction, including without limitation the rights to\n use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\n the Software, and to permit persons to whom the Software is furnished to do so,\n subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\n FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\n COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\n IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\n CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n ",
"summary": "Asynchronous and distributed scheduling of Ewoks workflows from python",
"version": "1.3.1",
"project_urls": {
"Changelog": "https://gitlab.esrf.fr/workflow/ewoks/ewoksjob/-/blob/main/CHANGELOG.md",
"Documentation": "https://ewoksjob.readthedocs.io/",
"Homepage": "https://gitlab.esrf.fr/workflow/ewoks/ewoksjob/",
"Issues": "https://gitlab.esrf.fr/workflow/ewoks/ewoksjob/issues",
"Repository": "https://gitlab.esrf.fr/workflow/ewoks/ewoksjob/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "168c6eaf977c5bda56392240adce3c653bd46ac6a3754a10216b8c5040313740",
"md5": "056320eed2c686c3a9e79029eb34a400",
"sha256": "dac9802861a2508602c5b5572e6cec94875f9b9dd3e89e7bbb46de6cc85e1183"
},
"downloads": -1,
"filename": "ewoksjob-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "056320eed2c686c3a9e79029eb34a400",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 33132,
"upload_time": "2025-11-02T18:02:46",
"upload_time_iso_8601": "2025-11-02T18:02:46.832861Z",
"url": "https://files.pythonhosted.org/packages/16/8c/6eaf977c5bda56392240adce3c653bd46ac6a3754a10216b8c5040313740/ewoksjob-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-02 18:02:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ewoksjob"
}
