Metadata-Version: 2.4
Name: ewoksxrpd
Version: 1.2.1
Summary: Data processing workflows for SAXS/WAXS
Author-email: ESRF <dau-pydev@esrf.fr>
License: # MIT License
        
        **Copyright (c) 2021 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/ewoksxrpd/
Project-URL: Documentation, https://ewoksxrpd.readthedocs.io/
Project-URL: Repository, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksxrpd/
Project-URL: Issues, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksxrpd/issues
Project-URL: Changelog, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksxrpd/-/blob/main/CHANGELOG.md
Keywords: orange3 add-on,ewoks
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy<2
Requires-Dist: scipy
Requires-Dist: silx!=2.1.0,>=1.1.0
Requires-Dist: pyopencl
Requires-Dist: pyfai>=2024.1
Requires-Dist: numexpr!=2.8.6
Requires-Dist: ewoksdata>=1.2.0
Requires-Dist: ewoks[orange]>=0.1.2
Requires-Dist: fabio
Requires-Dist: h5py
Requires-Dist: packaging
Requires-Dist: redis!=5.3.0b1,!=5.3.0b3
Provides-Extra: online
Requires-Dist: ewoksdata[online]; extra == "online"
Provides-Extra: test
Requires-Dist: pytest>=7; extra == "test"
Requires-Dist: matplotlib>=3.1; extra == "test"
Requires-Dist: pyqt5; extra == "test"
Provides-Extra: dev
Requires-Dist: ewoksxrpd[test]; extra == "dev"
Requires-Dist: black>=25; extra == "dev"
Requires-Dist: flake8>=4; extra == "dev"
Provides-Extra: doc
Requires-Dist: ewoksxrpd[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: ewokssphinx>=0.3.0; extra == "doc"
Dynamic: license-file

# ewoksxrpd

Workflows for data processing for SAXS/WAXS

## Getting started

Install the [ewoksxrpd](https://ewoksxrpd.readthedocs.io/en/latest/) Python package

```
pip install ewoksxrpd
```
## How to use

Run an example workflow

```bash
python examples/job.py
```

Run an example workflow with GUI

```bash
ewoks execute examples/xrpd_workflow.json --engine=orange --data-root-uri=/tmp --data-scheme nexus
```

or for an installation with the system python

```bash
python3 -m ewoks execute examples/xrpd_workflow.json --engine=orange --data-root-uri=/tmp --data-scheme nexus
```

Produce the example data

```bash
pytest --examples
```

## Documentation

https://ewoksxrpd.readthedocs.io/
