ewoksscxrd 0.6.1

Ewoks SC-XRD workflows

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:

• doc/tutorials/from_eiger_to_crysalis.md

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.json
• demo_eiger2crysalis_lima2.json
• demo_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.