pylag.processing.gotm module

Tools to assist with analysing GOTM based outputs

pylag.processing.gotm.get_rmse(gotm_file_name, gotm_var_name, pylag_file_names, dates, gotm_time_rounding, pylag_time_rounding, mass_factor=1.0)[source]

Compute the RMSE

Compute the RMSE between GOTM and PyLag model outputs.

Parameters

  • gotm_file_name (str) – Name of the file containing output from the Eulerian model. At the moment, only GOTM-based outptus are supported.

  • gotm_var_name (str) – The name of the GOTM variable we will comare the output of the particle tracking model with.

  • pylag_file_names (list[str]) – List of sorted PyLag output files. Each output file corresponds to one member of the ensemble.

  • dates (1D NumPy array ([t], datetime)) – Dates on which to compute the emsemble mean concentration.

  • gotm_time_rounding (int) – The number of seconds GOTM outputs should be rounded to.

  • pylag_time_rounding (int) – The number of seconds PyLag outputs should be rounded to.

Returns

rmse – The RMSE.

Return type

float