Metadata-Version: 2.4
Name: ewoksscxrd
Version: 0.6.3
Summary: Ewoks SC-XRD workflows
Author-email: ESRF <dau-pydev@esrf.fr>
License: # MIT License
        
        **Copyright (c) 2024-2025 European Synchrotron Radiation Facility**
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of
        this software and associated documentation files (the "Software"), to deal in
        the Software without restriction, including without limitation the rights to
        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
        the Software, and to permit persons to whom the Software is furnished to do so,
        subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksscxrd/
Project-URL: Documentation, https://ewoksscxrd.readthedocs.io/
Project-URL: Repository, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksscxrd/
Project-URL: Issues, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksscxrd/issues
Project-URL: Changelog, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksscxrd/-/blob/main/CHANGELOG.md
Keywords: ewoks
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numexpr
Requires-Dist: fabio
Requires-Dist: ewoks
Requires-Dist: cryio
Requires-Dist: silx
Requires-Dist: pyicat-plus
Provides-Extra: test
Requires-Dist: pytest>=7; extra == "test"
Provides-Extra: dev
Requires-Dist: ewoksscxrd[test]; extra == "dev"
Requires-Dist: ruff>=0.4; extra == "dev"
Provides-Extra: doc
Requires-Dist: ewoksscxrd[test]; extra == "doc"
Requires-Dist: sphinx>=4.5; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints>=1.16; extra == "doc"
Requires-Dist: pydata_sphinx_theme; extra == "doc"
Requires-Dist: myst-parser; extra == "doc"
Dynamic: license-file

# 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:

```sh
pip install ewoksscxrd
```

Install from source:

```sh
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`](./doc/tutorials/from_eiger_to_crysalis.md)

Inspect expected inputs:

```sh
ewoks show src/ewoksscxrd/workflows/demo_eiger2crysalis.json
```

Execute only after providing inputs in the workflow JSON (for example with
`default_inputs`):

```sh
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](https://ewoksscxrd.readthedocs.io)

## Contributing

Contributions are welcome. Please see
[`CONTRIBUTING.md`](./CONTRIBUTING.md).

## License

This project is licensed under the MIT License. See
[`LICENSE.md`](./LICENSE.md).

## Support

For issues, open a ticket on the GitLab project or contact ESRF support via a
[data processing request ticket](https://requests.esrf.fr/plugins/servlet/desk/portal/41).
