Ewoks SC-XRD workflows
Project description
ewoksscxrd
The ewoksscxrd project is a Python library providing Ewoks tasks and workflows for Single-Crystal X-Ray Diffraction (SC-XRD) data processing. It includes conversion paths to CrysAlis outputs, CBF stacks, TIFF stacks, and data-publication helpers.
Installation
By default at ESRF, ewoksscxrd is typically deployed on Ewoks workers by the
DAU team. For a manual installation, use Python 3.10+.
Install from PyPI:
pip install ewoksscxrd
Install from source:
git clone https://gitlab.esrf.fr/workflow/ewoksapps/ewoksscxrd.git
cd ewoksscxrd
pip install -e .
Quickstart
The bundled workflows require input configuration (paths, geometry, and processing parameters). Start with the tutorial:
Inspect expected inputs:
ewoks show src/ewoksscxrd/workflows/demo_eiger2crysalis.json
Execute only after providing inputs in the workflow JSON (for example with
default_inputs):
ewoks execute path/to/workflow_with_inputs.json
Alternative bundled workflows:
demo_eiger2cbf.jsondemo_eiger2crysalis_lima2.jsondemo_tiff_save.json
The tutorial above covers input configuration and the full end-to-end conversion example.
Documentation
Full documentation is available online here: ReadTheDocs
Contributing
Contributions are welcome. Please see
CONTRIBUTING.md.
License
This project is licensed under the MIT License. See
LICENSE.md.
Support
For issues, open a ticket on the GitLab project or contact ESRF support via a data processing request ticket.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ewoksscxrd-0.6.2.tar.gz.
File metadata
- Download URL: ewoksscxrd-0.6.2.tar.gz
- Upload date:
- Size: 47.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84fc1161eb343b731d683a4dd65c4ab7f724c0ffbd41b3fc8f654ce2f7d957b5
|
|
| MD5 |
0cfc9ad9caa720f153fd2c4140d462ab
|
|
| BLAKE2b-256 |
3b01078c417f839431df7eac8b3ca02a2fb5e1d6710f0ab0842c845350455187
|
File details
Details for the file ewoksscxrd-0.6.2-py3-none-any.whl.
File metadata
- Download URL: ewoksscxrd-0.6.2-py3-none-any.whl
- Upload date:
- Size: 48.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8c12fa88a92e1b7922f853c2dc5a9cc812d0655674a7d3c244947d4dec57d3f9
|
|
| MD5 |
5490166e43517526b6aa3c52706aa6e6
|
|
| BLAKE2b-256 |
0c8e5d5692b2e204ae046b2b9e606e170e4fd195ddac8ffdef1d47c522b62060
|
