ocmw.calval.flowValidation module

Functions to generate validation statistics for timeseries of flow parameters from the model against in situ ADCP measurements.

The input timeseries are generated using the ocmw.dataproc.ocmw_extract functions on common timestamps.

validateFlowParameter

Validation of model velocity data against in situ ADCP data

Tools for applying validation analysis to pre-preocess extracts of model and instrument data.

ocmw.calval.flowValidation.validateFlowParameter(modFile, obsFile, paramList, doFlowChar=True, varStr='Velocity', velLims=[0.0, 4.5])[source]

Validation of model velocity data against in situ ADCP data

Parameters:

  • modFile (str) – Full path to model data file.

  • obsFile (str) – Full path to in situ measurements data file.

  • paramList (list,str) – List of parameters to be processed.

  • doFlowChar (bool) – Flag to toggle application of flow characterisation. Default=True

  • varStr (str) – Variable definition used in plot titles.

  • velLims (list,float) – Lower and upper limits for velocity correlation plot axes.

Returns:

  • metrics (dict) – Dictionary of validation metrics for all, flood and ebb tide states.

  • figHnds (dict) – Dictionary of figure handles for all graphics generated.

  • metadata (dict) – Dictionary with information describing data being compared

ocmw.calval.flowValidation.valid_results_to_file(info, unitStr, metrics, outfile)[source]