pylag.processing.fvcom module

Tools to assist with analysing FVCOM based outputs

pylag.processing.fvcom.get_rmse(fvcom_file_name, fvcom_var_name, pylag_file_names, dates, pylag_time_rounding, mass_factor=1.0, n_points=None)[source]

Compute the RMSE

Compute the RMSE between FVCOM and PyLag model outputs.

Parameters

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

  • fvcom_var_name (str) – The name of the FVCOM 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.

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

  • mass_factor (float) – Factor used to convert probability densities into concentrations.

  • n_points (int, optional) – Restrict the comparison to the n points which have the highest FVCOM tracer concentration. If None, all grid points are compared.

Returns

rmse – The RMSE.

Return type

float