oceanval.validate

Contents

oceanval.validate#

oceanval.validate(lon_lim=None, lat_lim=None, concise=True, variables='all', fixed_scale=False, region=None, data_dir='.', out_dir='.', zip=False, view=True, test=False, sim_info=None)#

Run the model evaluation for all of the available datasets, and generate a validation report.

Parameters:

  • lon_lim (list or None) – The longitude limits for the validation. Default is None

  • lat_lim (list or None) – The latitude limits for the validation. Default is None

  • variables (str or list) – The variables to run the model evaluation for. Default is “all”

  • fixed_scale (bool) – Whether to use a fixed scale for the seasonal plots. Default is False. If True, the minimum and maximum values are capped to cover the 2nd and 98th percentiles of both model and observations.

  • region (str or None) – The region being validated. Must be either “nwes” (northwest European Shelf) or “global”. Default is None.

  • view (bool) – Default is True. Open the validation report in a web browser after it is generated.

  • test (bool) – Default is False. Ignore, unless you are testing oceanval.

  • sim_info (dict or None) – A dictionary containing simulation information to be added to the report. Default is None.

Return type:

None

Contents