Allow to skip report generation in xfel-calibrate
Description
Adds the command line option --skip-reports
to xfel-calibrate
that skips generation of the report PDF while keeping all other metadata around it intact. In that case, it is moved to the output directory rather than the report path.
The main intent here is for low latency HED operation.
How Has This Been Tested?
xfel-calibrate ... --skip-reports
Types of changes
- New feature (non-breaking change which adds functionality)
Reviewers
Merge request reports
Activity
changed milestone to %3.5.0
- Resolved by Thomas Kluyver
added 1 commit
- f312e1f5 - Add xfel-calibrate option to skip report generation
1086 1092 parm_subdict[name] = p.value 1087 1093 1088 1094 metadata["pycalibration-version"] = version 1089 metadata["report-path"] = f"{report_to}.pdf" 1095 metadata["report-path"] = f"{report_to}.pdf" if report_to \ 1096 else '# REPORT SKIPPED #' - Comment on lines +1095 to +1096
At present, the reproduction machinery (
xfel_calibrate.repeat
) will use this value from the yaml file as the report destination when it you re-run a correction. So you might end up with PDF files literally called# REPORT SKIPPED #
.Reports from reproduction need a rethink anyway - see #57 - so this doesn't necessarily have to be addressed in this MR, but I thought it worth mentioning.
mentioned in commit 40ff9f7c