Run a fit¶

The command line loads a complete project and runs the analysis its settings declare. Use it for a single pattern, joint experiments, or a scan.

Run the project¶

edi fit path/to/project

python -m edi fit path/to/project

For a folder or its project.edi, this command fits and saves the project back to that folder when the run succeeds. Keep the initial model separately when you want to compare it with the result.

Choose the output¶

edi fit path/to/project --output fitted-project
edi fit path/to/project --dry

python -m edi fit path/to/project --output fitted-project
python -m edi fit path/to/project --dry

--output DIR keeps the result in another folder. With the standalone executable, choose a new folder and use either --output or --dry. A dry run still performs the fit and leaves the input files unchanged. It keeps no scan progress.

For an archive:

edi fit project.zip --output fitted-project

python -m edi fit project.zip --output fitted-project

Without an output folder, fit leaves the input archive unchanged and warns that the results are not written back. See files and output.

Inspect more detail¶

edi fit path/to/project --verbosity full

python -m edi fit path/to/project --verbosity full

Full output includes the fitted parameter table. The Python package's command line also reports per-bank agreement factors for a joint fit.

Follow progress¶

Live progress is available in the Python package's command line. Its human channel reports progress during a single fit. A scan reports progress per measured file; full verbosity adds its iteration detail. To request live progress records on the machine channel for a single or joint fit:

python -m edi fit path/to/project --report machine --stream

Machine streaming is not emitted for scans, whose independent per-file iterations are a different progression.

Read machine output¶

edi fit path/to/project --report machine

python -m edi fit path/to/project --report machine

The machine report uses a versioned key=value record suitable for comparing runs.

The chosen report goes to standard output; warnings and errors go to standard error. Preserve both when you need a record of an unattended run.

Fitting mode and minimizer¶

The project declares single, joint, sequential or independent mode. Its _minimizer settings choose the descent strategy, tolerance and iteration budget. They are project data, not extra fit flags. See fitting modes.

Stop and resume¶

In the Python package's command line, Ctrl+C requests a clean cancellation. The command exits with status 130. A cancelled single or joint fit leaves the project unchanged; a scan retains completed file results so running the same command can resume. A dry run retains no scan progress. A second Ctrl+C terminates immediately.

Prepare a report¶

python -m edi report path/to/project
python -m edi report path/to/project --check

The first command writes the selected report formats except PDF. The second checks whether saved reports are current without writing them.

Continue visually¶

Open the saved project in the application. Its structures and experiments are the same ones the command line reads.