README.rst 1.15 KB
Newer Older
1
2
3
4
5
6
7
8
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
------------

Julia Garriga Ferrer's avatar
Julia Garriga Ferrer committed
9
10
11
12
13
14
15
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
16
17
18
19
20
21
22
23
24

.. code-block:: bash

    pip install darfix

To install from sources:

.. code-block:: bash

Julia Garriga Ferrer's avatar
Julia Garriga Ferrer committed
25
    git clone https://gitlab.esrf.fr/XRD/darfix.git
26
27
28
29
30
31
32
33
    cd darfix
    pip install -r requirements.txt
    pip install .

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

.. code-block:: bash

34
35
36
37
38
39
40
    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
41
42
43
44

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