wind_validation.create_report

wind_validation.create_report(validation_results: Union[list[xr.Dataset], xr.Dataset], **kwargs) → None[source]

Create HTML report from validation results comparing model with data. It is also possible to compare multiple model on the same dataset to inspect the performance of different techniques against observations.

Parameters

  • validation_results (xarray.Dataset | list[xr.Dataset]) – Validation result produced by main “validate” function. The results are compatible with this reporting function. If comparing multiple models a list of datasets can be passed with the same structure as described before.

  • obs_name (str | list[str], optional) – Observations site name will be used in the general description of a report. This can be string when comparing single model to single observation dataset however when making comparison the list of names is required because otherwise there is no way to make a distinction between models.

  • mod_name (str | list[str], optional) – Model name will be used in the general description of a report. This can be string when comparing single model to single observation dataset however when making comparison the list of names is required because otherwise there is no way to make a distinction between models.

  • dest (str, optional) – Path of the html file to write the report to. If not provided html file is saved in tmp directory. By default None

  • author (str, optional) – Author of the generated report to be stated in the description. By default “”

  • show (bool, optional) – If True - tries to open the report in the browser right away. By default False

Raises

RuntimeError – If destination folder doesn’t exist the generation will fail. If results type doesn’t match the documented ones. If model and observation names are not provided for comparison report.