Ewoksid31 commands reference

ewoksid31 provides several command-line tools for data processing and workflow execution.

id31-integrate (GUI)

Launch the graphical user interface for data processing:

id31-integrate

How to use:

usage: id31-integrate [-h] [-f] [-i FILE] [-o FOLDER] [-c FILE]
                      [--flat-dir FOLDER] [-v]
                      [FOLDER]

Positional Arguments

FOLDER

Default directory for raw/config/output dialogs (ex: /data/visitor/in1176/id31/20250412)

Named Arguments

-f, --fresh

Start without loading previous user preferences

Default: False

-i, --input

Dataset file to process (HDF5 format)

Default: ''

-o, --output-dir

Folder where to store the results

Default: ''

-c, --pyfai-config

PyFAI config file (.json)

--flat-dir

Folder containing flat-field files: flats.mat and old_flats.mat (default: /data/id31/inhouse/P3/)

Default: '/data/id31/inhouse/P3/'

-v, --verbose

Increase verbosity level (-v: INFO, -vv:DEBUG)

Default: 0

streamline-autocalib

Perform automatic calibration using predefined workflows.

usage: streamline-autocalib [-h] -k KIND [--session SESSION] [--sample SAMPLE]
                            [--dataset DATASET] [--calibrant CALIBRANT]
                            [--max-rings MAX_RINGS [MAX_RINGS ...]] [--worker]
                            [-v] [--dry-run] [-i FILE] [-o FOLDER] [-c FILE]
                            [--flat-dir FOLDER]

Named Arguments

-k, --kind

Kind of streamline measurment: pdf, xrd, saxs

--session

Session as: <proposal>/<beamline>/<session> (default: in1176/id31/20251010)

Default: 'in1176/id31/20251010'

--sample

Sample name (default depends on kind argument)

--dataset

Dataset number (default: 1)

Default: 1

Calibration

--calibrant

Name of the calibrant used for calibration image (default depends on kind argument)

--max-rings

Number of rings to use. Use multiple values to refine over an increasing number of rings (default depends on kind argument)

Runtime

--worker

Execute workflows on ewoks worker instead of current environment

Default: False

-v, --verbose

Increase verbosity

Default: 0

--dry-run

Do not run anything but print which datasets would be processed

Default: False

Extra

Overrides configuration from session, sample & dataset

-i, --input

Dataset file to process (HDF5 format)

-o, --output-dir

Folder where to store the results

-c, --pyfai-config

PyFAI config file (.json)

--flat-dir

Folder containing flat field files: flats.mat and old_flats.mat

Example of usage:

streamline-autocalib --kind pdf --dataset 1 --calibrant LaB6_SRM660c