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.
4 maintainers
Metadata
4 maintainers
Release files for ewoksscxrd 0.6.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ewoksscxrd-0.6.4.tar.gz | 47.8 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ewoksscxrd-0.6.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 96.1 MB
Release files / ewoksscxrd-0.6.4.tar.gz
| Download URL | ewoksscxrd-0.6.4.tar.gz |
|---|---|
| Size | 47.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e88ff0096e1da77cb3ec2e1513475987b512bc9fe81045cb589a14b4211b74ac
|
|
BLAKE2b-256 checksum How to use checksums |
973925e97ce8d3423d9280401109113dc8b66bb278e86eea47104d88574c1626
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.10
|
Release files / ewoksscxrd-0.6.4-py3-none-any.whl
| Download URL | ewoksscxrd-0.6.4-py3-none-any.whl |
|---|---|
| Size | 48.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9b1101302fef6377e9d84a62628509ea803341b6ef0adff1a961f50ab7975244
|
|
BLAKE2b-256 checksum How to use checksums |
8b44f72abb09d22db8a4569e9d73c5c6c68cfe3375d56e89107dac21af194b6b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.10
|
