Skip to content

Command reference

The standalone executable supports fit. The Python package's command line supports fit, calc, report, export, undo, and collection. Use your installed version's help to see its options.

edi --help
edi fit --help

python -m edi --help
python -m edi fit --help

Fit

The standalone executable accepts:

edi fit PROJECT [--dry | --output DIRECTORY]
    [--verbosity off|compact|full] [--report human|machine]

The Python package's command line accepts:

python -m edi fit PROJECT [--output DIR] [--dry]
    [--verbosity off|compact|full] [--report human|machine] [--stream]

Default output is the human report at compact verbosity. A successful fit normally saves its folder. --dry executes without writing; a zip requires --output DIR to retain results. Full guide.

Calculate

python -m edi calc PROJECT [--output DIR] [--dry]
    [--verbosity off|compact|full] [--report machine|human]

Default output is the machine report at compact verbosity. The project supplies its grid and model. Full guide.

Report

python -m edi report PROJECT [--check] [--output PATH]
    [--offline|--online] [--x-axis native|d_spacing]
    [--correlation-threshold X] [--correlation-experiment NAME]
    [--exclude KEY ...|--include-all] [--colour-scheme NAME]

--check checks saved-report freshness without writing. --output PATH writes an HTML document instead of updating the saved-report list. Full guide.

Export

python -m edi export PROJECT --output FILE.zip

-o is the short output spelling. This packages the project folder as last saved. Files and output.

Undo the last saved fit

The standalone executable has no undo; use the Python package.

python -m edi undo path/to/project --dry
python -m edi undo path/to/project --report human

The first command previews what would be restored. The second restores the persisted pre-fit state and saves it back when a snapshot exists. undo --dry is a preview, unlike fit --dry and calc --dry, which run their computations.

Undo supports --verbosity off|compact|full and --report machine|human; it defaults to a compact machine report. If no fit state is recorded, it reports that there is nothing to undo.

Output and exit status

For fit, calc and undo, the selected report is stdout, while warnings and errors are stderr. A failed run exits nonzero. A clean cancellation in the Python package's command lI uses status 130. Report freshness checking uses status 1 when a listed saved report is not current.