Installation#

Installing darfix involves creating a python environment, installing dependencies and potentially Windows enabling long paths.

Environment#

It is recommended to create a virtual environment to avoid conflicts between dependencies.

On Linux or Mac

python3 -m venv /path/to/new/virtual/environment

source /path/to/new/virtual/environment/bin/activate

On Windows

python3 -m venv C:\path\to\new\virtual\environment

C:\path\to\new\virtual\environment\Scripts\activate.bat

Note: To deactivate the environment call: deactivate

Installation#

Installation from pypi#

Recommended installation ( with all darfix dependencies) is:

pip install darfix[full]

Note

To install darfix with a minimal set of dependencies you can run instead

pip install darfix

Hint

if you have trouble during installation see the Troubleshooting section

Install from source#

git clone https://gitlab.esrf.fr/XRD/darfix.git
cd darfix
pip install .[full]

Note

Or without all its dependencies:

pip install .

Hint

if you have trouble during installation see the Troubleshooting section

Test#

To test the orange workflow (only if you have access to the source code)

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

To test a workflow execution without the canvas (only if you have access to the source code)

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

Troubleshooting#

On Windows you may get this intallation error

Building wheels for collected packages: ewoksorange
Building wheel for ewoksorange (pyproject.toml) ... error
error: subprocess-exited-with-error

× Building wheel for ewoksorange (pyproject.toml) did not run successfully.
│ exit code: 1
╰─> [154 lines of output]
    ...
    error: could not create 'build\lib\ewoksorange\tests\examples\ewoks_example_1_addon\orangecontrib\ewoks_example_supercategory\ewoks_example_subcategory\tutorials\sumtask_tutorial3.ows': No such file or directory
    [end of output]

note: This error originates from a subprocess, and is likely not a problem with pip.
ERROR: Failed building wheel for ewoksorange
Failed to build ewoksorange
ERROR: Could not build wheels for ewoksorange, which is required to install pyproject.toml-based projects

Instructions on how to enable long paths in Windows 10 or later can be found here.

Getting started#

Start the graphical interface

orange-canvas

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

Dependencies#

The mandatory dependencies are:

numpy
silx

The GUI widgets depend on the following extra packages:

Some of the image processing techniques depend on:

Tools for reading and writing files depend on the following packages:

h5py for HDF5 files

Package for using batch processing:

ewoksorange