Metadata-Version: 2.1
Name: darfix
Version: 0.8.0
Summary: Computer vision software for the interpretation of diffraction images
Home-page: https://gitlab.esrf.fr/XRD/darfix
Author: ada group
Author-email: julia.garriga@esrf.fr
License: MIT License
Description: 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
        ------------
        
        If you are on Linux:
        --------------------
        
        It is recommended to create a virtual environment to avoid conflicts between dependencies (https://docs.python.org/3/library/venv.html).
        
        .. code-block:: bash
        
            python3 -m venv /path/to/new/virtual/environment
        
            source /path/to/new/virtual/environment/bin/activate
        
        *Note: To deactivate the environment call:* :code:`deactivate`
        
        Then, you can install darfix with all its dependencies:
        
        .. code-block:: bash
        
            pip install darfix[full]
        
        To install darfix with a minimal set of dependencies run instead:
        
        .. code-block:: bash
        
            pip install darfix
        
        Start the GUI and make sure darfix appears as an add-on:
        
        .. code-block:: bash
        
            orange-canvas
        
        If you are on Windows:
        ----------------------
        
        The easiest way is to install Miniconda: https://docs.conda.io/en/latest/miniconda.html
        
        After installed, open **Anaconda Prompt** and install the following packages:
        
        .. code-block:: bash
        
            conda config --add channels conda-forge
        
            conda install orange3 silx scikit-image opencv
        
        And install darfix and ewoks:
        
        .. code-block:: bash
        
            pip install ewoks[orange] darfix
        
        Start the GUI and make sure darfix appears as an add-on:
        
        .. code-block:: bash
        
            orange-canvas
        
        
        To install from sources:
        ------------------------
        
        .. code-block:: bash
        
            git clone https://gitlab.esrf.fr/XRD/darfix.git
            cd darfix
            pip install .
        
        Or with all its dependencies:
        
        .. code-block:: bash
        
            pip install .[full]
        
        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
        
        User guide
        ----------
        
        A user guide can be downloaded at http://www.edna-site.org/pub/doc/darfix/latest/user_guide.html
        
Platform: linux
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Win32 (MS Windows)
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 :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: full
Provides-Extra: test
Provides-Extra: doc
