API Reference

API Reference#

Matchups and validation#

add_point_comparison([name, long_name, ...])

Add a point comparison variable to the Validator

add_gridded_comparison([name, long_name, ...])

Add a gridded comparison variable to the Validator

matchup([sim_dir, start, end, lon_lim, ...])

Match up model with observational data

validate([lon_lim, lat_lim, concise, ...])

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

reset()

Reset the matchup definitions to their default state.

rebuild([data_dir])

Rebuild the validation report after modifying notebooks.

deep_clean()

Deep temp file cleaner.

fvcom_preprocess([variables, paths, ...])

Preprocess FVCOM data for gridding and regridding.