pydox.calibration.MethodInAir.to_report

MethodInAir.to_report(a_float: ArgoFloat, file_name: str | None = None, **kwargs)

Create a calibration report

Parameters:

• a_float (argopy.ArgoFloat) – The Argo float to use for the report, must be the same used to fit this instance.

• file_name (str) – The file name of the report to write.

Return type:

pathlib.Path

Notes

• The best fit ID must be selected with set_best_fit()

• Only HTML format are supported at this point

• The report is based on the template defined in settings

See also

pydox.reporting.CalibrationHTMLReport

Path to published report, using settings along the convention: <output.root>/<WMO>/<reports.save.path>/<reports.save.prefix>{report_name}.<reports.save.format>