| Name | ewokstomo JSON |
| Version |
0.2.6
JSON |
| download |
| home_page | None |
| Summary | Data processing workflows for Tomography |
| upload_time | 2025-07-10 11:43:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | # MIT License
**Copyright (c) 2024 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 |
ewoks
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ewokstomo
The **ewokstomo** project is a Python library designed to provide workflow tasks for Tomographic Data Processing using Ewoks (Extensible Workflow System).
## Installation
By default, at the ESRF, `ewokstomo` should be installed on Ewoks workers using an Ansible script by the DAU team.
If you wish to install `ewokstomo` manually, ensure you have Python 3.10+ and `pip` installed. You can install the library directly from PyPI:
```sh
pip install ewokstomo
```
Alternatively, to install from source, clone this repository and run:
```sh
git clone https://gitlab.esrf.fr/workflow/ewoksapps/ewokstomo.git
cd ewokstomo
pip install -e .
```
## Quickstart Guide
### Running an `ewokstomo` Workflow
Most of the time, the workflow will be automatically ran from the Bliss control system.
However if you wish to execute the workflow by hand, you can use the following:
`ewoks execute workflow.json`
Some examples of workflow are found in `ewokstomo/workflows`
## How-To Guides
For detailed instructions on various tasks, please refer to the How-To Guides in the documentation, which cover topics such as:
- Configuration of tomography workflows
- Running workflows locally for testing
- Using the API to run specific tasks (e.g., NXtomo conversion, reconstruction)
## Documentation
Comprehensive documentation, including an API reference, tutorials, and conceptual explanations, can be found in the [doc directory](./doc) or online at the [ReadTheDocs page](https://ewokstomo.readthedocs.io).
## Contributing
Contributions are welcome! To contribute, please:
1. Clone the repository and create a new branch for your feature or fix.
2. Write tests and ensure that the code is well-documented.
3. Submit a merge request for review.
See the [`CONTRIBUTING.md`](./CONTRIBUTING.md) file for more details.
## License
This project is licensed under the MIT License. See the [`LICENSE.md`](./LICENSE.md) file for details.
## Support
If you have any questions or issues, please open an issue on the GitLab repository or contact the support team via a [data processing request ticket](https://requests.esrf.fr/plugins/servlet/desk/portal/41).
Raw data
{
"_id": null,
"home_page": null,
"name": "ewokstomo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ewoks",
"author": null,
"author_email": "ESRF <dau-pydev@esrf.fr>",
"download_url": "https://files.pythonhosted.org/packages/f7/2b/c038c341e92ca2cf3495a551586372fa6d70d8d95391f3bc738497f41fb5/ewokstomo-0.2.6.tar.gz",
"platform": null,
"description": "# ewokstomo\n\nThe **ewokstomo** project is a Python library designed to provide workflow tasks for Tomographic Data Processing using Ewoks (Extensible Workflow System).\n\n## Installation\n\nBy default, at the ESRF, `ewokstomo` should be installed on Ewoks workers using an Ansible script by the DAU team.\nIf you wish to install `ewokstomo` manually, ensure you have Python 3.10+ and `pip` installed. You can install the library directly from PyPI:\n\n```sh\npip install ewokstomo\n```\n\nAlternatively, to install from source, clone this repository and run:\n\n```sh\ngit clone https://gitlab.esrf.fr/workflow/ewoksapps/ewokstomo.git\ncd ewokstomo\npip install -e .\n```\n\n## Quickstart Guide\n\n### Running an `ewokstomo` Workflow\n\nMost of the time, the workflow will be automatically ran from the Bliss control system.\nHowever if you wish to execute the workflow by hand, you can use the following:\n\n`ewoks execute workflow.json`\n\nSome examples of workflow are found in `ewokstomo/workflows`\n\n## How-To Guides\n\nFor detailed instructions on various tasks, please refer to the How-To Guides in the documentation, which cover topics such as:\n\n- Configuration of tomography workflows\n- Running workflows locally for testing\n- Using the API to run specific tasks (e.g., NXtomo conversion, reconstruction)\n\n## Documentation\n\nComprehensive documentation, including an API reference, tutorials, and conceptual explanations, can be found in the [doc directory](./doc) or online at the [ReadTheDocs page](https://ewokstomo.readthedocs.io).\n\n## Contributing\n\nContributions are welcome! To contribute, please:\n\n1. Clone the repository and create a new branch for your feature or fix.\n2. Write tests and ensure that the code is well-documented.\n3. Submit a merge request for review.\n\nSee the [`CONTRIBUTING.md`](./CONTRIBUTING.md) file for more details.\n\n## License\n\nThis project is licensed under the MIT License. See the [`LICENSE.md`](./LICENSE.md) file for details.\n\n## Support\n\nIf you have any questions or issues, please open an issue on the GitLab repository or contact the support team via a [data processing request ticket](https://requests.esrf.fr/plugins/servlet/desk/portal/41).\n",
"bugtrack_url": null,
"license": "# MIT License\n \n **Copyright (c) 2024 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": "Data processing workflows for Tomography",
"version": "0.2.6",
"project_urls": {
"Changelog": "https://gitlab.esrf.fr/workflow/ewoksapps/ewokstomo/-/blob/main/CHANGELOG.md",
"Documentation": "https://ewokstomo.readthedocs.io/",
"Homepage": "https://gitlab.esrf.fr/workflow/ewoksapps/ewokstomo/",
"Issues": "https://gitlab.esrf.fr/workflow/ewoksapps/ewokstomo/issues",
"Repository": "https://gitlab.esrf.fr/workflow/ewoksapps/ewokstomo/"
},
"split_keywords": [
"ewoks"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f72bc038c341e92ca2cf3495a551586372fa6d70d8d95391f3bc738497f41fb5",
"md5": "8e25683d5c9199491e2713cfa0d41d3b",
"sha256": "e209518086724ba1949950d667ad9a05ce075ce99eb09b5d81c07b731706799a"
},
"downloads": -1,
"filename": "ewokstomo-0.2.6.tar.gz",
"has_sig": false,
"md5_digest": "8e25683d5c9199491e2713cfa0d41d3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 142348,
"upload_time": "2025-07-10T11:43:48",
"upload_time_iso_8601": "2025-07-10T11:43:48.263105Z",
"url": "https://files.pythonhosted.org/packages/f7/2b/c038c341e92ca2cf3495a551586372fa6d70d8d95391f3bc738497f41fb5/ewokstomo-0.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 11:43:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ewokstomo"
}
