Darfix#
darfix is a project to create and execute workflows to process dark-field X-ray microscopy data acquired at the ID03 beamline at ESRF.
It provides a graphical user interface based on Orange to load the data, pretreat it and derive grain plots or rocking curves (see Garriga Ferrer J. et al. 2023 for more details).
These operations (or tasks) can be arranged as computational data pipelines, also called workflows, and can be run headless with Ewoks.
Installation#
You can install darfix as any usual Python package
pip install darfix[full]
Tip
It is recommended to create a virtual environment to avoid conflicts between dependencies. Click below for instructions on how to do so.
Create a virtual environment
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
At ESRF
On a computer inside ESRF network, you can load darfix by running
module load darfix
Troubleshooting
On Windows you may get this installation 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
If you do, you need to enable long paths. Instructions to do this in Windows 10 or later can be found here.
Usage#
Launch the Orange canvas
darfix
Then, you can have a look at the example workflows in Help > Example workflows.
The Tutorials and the Widgets documentation give detailed explanations on the different tasks in the example workflows.
If you already have a workflow, you can open it directly in the Orange canvas using
darfix my_workflow.ows