Ewoks SC-XRD workflows
Project description
ewoksscxrd
The ewoksscxrd project is a Python library designed to provide workflow tasks for Single-Crystal X-Ray Diffraction (SC-XRD) Data Processing using Ewoks (Extensible Workflow System).
Installation
By default, at the ESRF, ewoksscxrd
should be installed on Ewoks workers using an Ansible script by the DAU team.
If you wish to install ewoksscxrd
manually, ensure you have Python 3.8+ and pip
installed. You can install the library directly from PyPI:
pip install ewoksscxrd
Alternatively, to install from source, clone this repository and run:
git clone https://gitlab.esrf.fr/workflow/ewoksapps/ewoksscxrd.git
cd ewoksscxrd
pip install -e .
Quickstart Guide
Running an ewoksscxrd
Workflow
How-To Guides
For detailed instructions on various tasks, please refer to the How-To Guides section in the documentation, which covers topics like:
- Configuration of the workflow
- Running the workflow locally
- Using the API to run specific tasks
Documentation
Comprehensive documentation, including an API reference, tutorials, and conceptual explanations, can be found in the docs 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file ewoksscxrd-0.5.4.tar.gz
.
File metadata
- Download URL: ewoksscxrd-0.5.4.tar.gz
- Upload date:
- Size: 47.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
28daaa9c997e958b691a14533bdbafc723cd674774c94eedad2ce4fee19f73c0
|
|
MD5 |
4ddc553cc05ff47bac856477d71fac7c
|
|
BLAKE2b-256 |
25efb4d9111d18c03b20f27e9ce16f5c3540dd1a4280f2ce892742158c728b7c
|