Save and check reports¶

The report command uses the project's structures, experiments, fit results and saved report settings. It presents the same document as Python and the application's Report page.

The shared Report chapter explains the scientific model; the steps below describe this interface.

Save the selected formats¶

python -m edi report path/to/project

This writes the formats selected by the project into its reports/ folder, for the available writers. HTML and CIF reports are written. The application writes PDF; the command leaves an existing PDF and its record as they are.

Saving a project does not automatically save its report. A report can become out of date after changes to the model or report contents.

Write an HTML file elsewhere¶

python -m edi report path/to/project --output report.html --offline

--output PATH writes one HTML report without changing the project's saved-report list. --offline embeds chart libraries; --online makes the HTML load them from the web. Both are overrides for this run.

Choose the contents¶

python -m edi report path/to/project --x-axis d_spacing --exclude data
python -m edi report path/to/project --exclude reflections --exclude correlations
python -m edi report path/to/project --include-all

Optional group keys are charts, correlations, reflections, data and evolution. Repeat --exclude for several groups, or use --include-all. These two choices are mutually exclusive.

Correlations and colours¶

These switches affect the generated report for that run; they do not replace the project's saved preferences.

Check saved reports¶

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

The command lists each saved report as current, out of date or missing, writing nothing. It exits with status 1 when a listed report is not current. It checks the saved list; it does not require that a project has already saved a report.