ocmw.calval.ww3WavesValidation module

Functions for calculating parameter based validation statistics for a set of matchup database records.

getVarName	Get variable names based on processsing options list
getSurfaceIndx	Get index of surface layer in depth data
extract_model	Extract model output for a specified variable
time_interpolate_obs	Interpolation of observation data onto the model output timestamps
initialize_results	Initialise a dictionary for collecting validation results
calculate_circular_metrics	Calculate circlar validation metrics for a pair of modelled and observation time series
calculate_metrics	Calculate standard validation metrics for a pair of modelled and observation time series
results_record	Create results recod from calculated validation metrics
store_valid_results	Store validation results record in the results dictionary
display_tabulated_results	Display validation results as a table on the standard output
save_cleaned_ts_data	Save cleaned matched model and buoy timeseries as a matlab *.mat binary file
load_binary_results	load binary results from a matlab file
process_record	Process a matched model/buoy data record
validate_records	Process a set of matched model/buoy data records

This module contains the functions for calculating parameter based validation statistics for a set of matchup database records.

ocmw.calval.ww3WavesValidation.getVarName(record, Options: list)

Get variable names based on processsing options list

ocmw.calval.ww3WavesValidation.getSurfaceIndx(record, dataFmt)

Get index of surface layer in depth data

ocmw.calval.ww3WavesValidation.extract_model(rscdfile, mVarName: str)

Extract model output for a specified variable

ocmw.calval.ww3WavesValidation.extract_obs(buoyfile, buoyDataFmt: str, varOptions: list)

Extract in situ buoy data for a specified data foramt and variable

ocmw.calval.ww3WavesValidation.time_interpolate_obs(t_obs, t_var, t_model)

Interpolation of observation data onto the model output timestamps

ocmw.calval.ww3WavesValidation.initialize_results()

Initialise a dictionary for collecting validation results

ocmw.calval.ww3WavesValidation.calculate_circular_metrics(model, obs, nsampl, degrees=True)

Calculate circlar validation metrics for a pair of modelled and observation time series

ocmw.calval.ww3WavesValidation.calculate_metrics(model, obs, nsampl)

Calculate standard validation metrics for a pair of modelled and observation time series

ocmw.calval.ww3WavesValidation.results_record(modelFileName, obsFileName, obsVarName, year, month, metrics)

Create results recod from calculated validation metrics

ocmw.calval.ww3WavesValidation.store_valid_results(store, results)

Store validation results record in the results dictionary

ocmw.calval.ww3WavesValidation.display_tabulated_results(store, mVarName)

Display validation results as a table on the standard output

ocmw.calval.ww3WavesValidation.save_tabulated_results(store, platform, mVarName, outpath)

Save tabulated validation results as an ASCII file

ocmw.calval.ww3WavesValidation.save_cleaned_ts_data(t, rscd, buoy, platform, mVarName, outpath, year, month)

Save cleaned matched model and buoy timeseries as a matlab *.mat binary file

ocmw.calval.ww3WavesValidation.load_binary_results(platform, mVarName, datapath)

load binary results from a matlab file

ocmw.calval.ww3WavesValidation.process_record(rec, buoyFmt: str, platform: str, mVarName: str, varOptions: list, pVarName: str, results_dir: str, angularData=False, plot_results=False)

Process a matched model/buoy data record

ocmw.calval.ww3WavesValidation.validate_records(records, dataFmt: str, platform: str, mVarName: str, varOptions: list, pVarName, results_dir, plot_results=False)

Process a set of matched model/buoy data records