Metadata-Version: 2.1
Name: darfix
Version: 0.7.2
Summary: Computer vision software for the interpretation of diffraction images
Home-page: https://gitlab.com/XRD/darfix
Author: data analysis unit
Author-email: julia.garriga@esrf.fr
License: MIT License
Platform: linux
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: X11 Applications :: Qt
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: numpy
Requires-Dist: setuptools
Requires-Dist: silx
Requires-Dist: ewokscore
Provides-Extra: doc
Requires-Dist: sphinx ; extra == 'doc'
Requires-Dist: nbsphinx ; extra == 'doc'
Requires-Dist: recommonmark ; extra == 'doc'
Provides-Extra: full
Requires-Dist: matplotlib (>=1.2.0) ; extra == 'full'
Requires-Dist: opencv-python (==4.1.2.30) ; extra == 'full'
Requires-Dist: scikit-image (>=0.17.1) ; extra == 'full'
Requires-Dist: PyQt5 ; extra == 'full'
Requires-Dist: orange3 ; extra == 'full'
Requires-Dist: ewoksorange ; extra == 'full'
Requires-Dist: tqdm ; extra == 'full'
Provides-Extra: test
Requires-Dist: pillow (==7.0.0) ; extra == 'test'

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.

Installation
------------

To install the last release with all its dependencies run

.. code-block:: bash

    pip install darfix[full]

To install it with a minimal set of dependencies run

.. code-block:: bash

    pip install darfix

To install from sources:

.. code-block:: bash

    git clone https://gitlab.esrf.fr/XRD/darfix.git
    cd darfix
    pip install -r requirements.txt
    pip install .

To test the orange workflow (only from sources) just run

.. code-block:: bash

    orange-canvas orangecontrib/darfix/tutorials/darfix_example2.ows

To test a workflow execution without the canvas (only from sources) just run

.. code-block:: bash

    darfix -wf orangecontrib/darfix/tutorials/darfix_example2.ows -fd orangecontrib/darfix/tutorials/ -td /tmp/darfix

Documentation
-------------
The documentation of the latest release is available at http://www.edna-site.org/pub/doc/darfix/latest


