Metadata-Version: 2.4
Name: darfix
Version: 3.0.1
Summary: Computer vision software for the interpretation of diffraction images
Author-email: ESRF <dau-pydev@esrf.fr>
License: The MIT license follows:
        
        Copyright (c) European Synchrotron Radiation Facility (ESRF)
        
        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/XRD/darfix/
Project-URL: Documentation, http://www.edna-site.org/pub/doc/darfix/latest
Project-URL: Repository, https://gitlab.esrf.fr/XRD/darfix/
Project-URL: Issues, https://gitlab.esrf.fr/XRD/darfix/issues
Project-URL: Changelog, https://gitlab.esrf.fr/XRD/darfix/-/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
Requires-Dist: numpy<3
Requires-Dist: silx<3,>=2.2.0
Requires-Dist: matplotlib
Requires-Dist: ewoks>=1.0.0
Requires-Dist: packaging
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: tqdm
Requires-Dist: eval_type_backport
Provides-Extra: full-noqt
Requires-Dist: opencv-python-headless>=4.3.0.36; extra == "full-noqt"
Requires-Dist: scikit-image>=0.17.1; extra == "full-noqt"
Requires-Dist: ewoksorange>=1.0.0; extra == "full-noqt"
Requires-Dist: hdf5plugin; extra == "full-noqt"
Provides-Extra: full
Requires-Dist: darfix[full_noqt]; extra == "full"
Requires-Dist: PyQt6; extra == "full"
Provides-Extra: test
Requires-Dist: darfix[full]; extra == "test"
Requires-Dist: pytest; extra == "test"
Provides-Extra: dev
Requires-Dist: darfix[test]; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8>=4; extra == "dev"
Requires-Dist: flake8_nb>=0.3.1; extra == "dev"
Requires-Dist: isort; extra == "dev"
Provides-Extra: doc
Requires-Dist: darfix[test]; extra == "doc"
Requires-Dist: sphinx>=4.5; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints>=1.16; extra == "doc"
Requires-Dist: sphinxcontrib-video; extra == "doc"
Requires-Dist: nbsphinx; extra == "doc"
Requires-Dist: ipykernel; extra == "doc"
Requires-Dist: recommonmark; extra == "doc"
Requires-Dist: pydata_sphinx_theme; extra == "doc"
Requires-Dist: ewokssphinx>=1.0.0; extra == "doc"
Requires-Dist: sphinx_design; extra == "doc"
Dynamic: license-file

# darfix

_darfix_ is a Python library for the analysis of dark-field microscopy data. It provides a series of computer vision techniques,
together with a graphical user interface and an [Orange3](https://github.com/biolab/orange3) add-on to define the workflow.

## Getting started

```bash
pip install darfix[full]
```

Then, launch the Orange canvas with

```bash
darfix
```

Drag widgets from the left panel to the canvas to start making your workflow.

## Documentation

The documentation of the latest release is available at https://darfix.readthedocs.io

## User guide

A user guide can be downloaded at https://darfix.readthedocs.io/en/latest/user_guide.html
