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.11+ and pip installed. You can install the library directly from PyPI:
pip install ewokstomo
Alternatively, to install from source, clone this repository and run:
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 or online at the ReadTheDocs page.
Contributing
Contributions are welcome! To contribute, please:
- Clone the repository and create a new branch for your feature or fix.
- Write tests and ensure that the code is well-documented.
- Submit a merge request for review.
See the CONTRIBUTING.md file for more details.
License
This project is licensed under the MIT License. See the 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.
4 maintainers
Metadata
4 maintainers
Release files for ewokstomo 0.10.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ewokstomo-0.10.1.tar.gz | 2.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ewokstomo-0.10.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.5 MB
Release files / ewokstomo-0.10.1.tar.gz
| Download URL | ewokstomo-0.10.1.tar.gz |
|---|---|
| Size | 2.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
592e29bdd13d4963faef211b51467b2c67ab21890f01113c77f8b0f41971bc18
|
|
BLAKE2b-256 checksum How to use checksums |
ee8717185fff0e6120f8d233987c7c4e1bbaf4c05362e8b104fba282771cc8c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.10
|
Release files / ewokstomo-0.10.1-py3-none-any.whl
| Download URL | ewokstomo-0.10.1-py3-none-any.whl |
|---|---|
| Size | 2.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
340c4369bfece22c1baa407c436e6717c662a059645876eba822d907b44aaddd
|
|
BLAKE2b-256 checksum How to use checksums |
aa346d366bc12e7f86aaf307a0746de0992dbbdf02013fc471dc1192c000d8da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.10
|
