Wavy

Welcome to wavy!

Introduction

wavy is an open source package with the main goal of easing the task of wave model validation and other metocean related tasks. The user can use in-situ observation or satellite altimeters for collocation, calibration, and validation. Variables that are commonly used are significant wave height, wind speed, and sea level anomaly but other variables can simply be added by the user.

Note

This project is under active development. I try to keep the documentation pristine. Please do not hesitate to contact me if you experience troubles, have questions, or would like to contribute.

Credits

If you are using wavy please mention the repo under https://github.com/bohlinger/wavy and for info from the documentation refer to this page https://wavyopen.readthedocs.io/. Additionally, the collocation methodology should be referred to with the following article:

• Bohlinger, P., Breivik, Ø., Economou, T., Müller, M.: A novel approach to computing super observations for probabilistic wave model validation, Ocean Modelling, 139, https://doi.org/10.1016/j.ocemod.2019.101404, 2019.

A selection of published studies and other work that use wavy can be found under wavy usage examples.

Contents

• Installation and setup
  • Installation for regular use
  • Installation for WEkEO
  • Installation for development
• Tutorials
  • Setting up a project and wavy config files
    • Setup
    • On the config files
  • Use satellite data
    • Download Satellite data
      • Preparations
      • Ammending config files
    • Import Satellite data
    • Importing multiple satellite products
    • Define regions of interest
    • Apply filters
  • Read model data
  • Read in-situ observations (netcdf/thredds, FROST API)
    • make a FROST call
    • read .nc-files
  • Follow storm track
  • Consolidate multiple retrievals
  • Collocating model output and observations
    • Collocation of satellite and wave model
    • Collocation of in-situ data and wave model
  • Validate the collocated time series
  • Validation metrics
  • Triple Collocation
    • Method
    • Example with wavy
    • References
  • Gridded satellite observations and statistics
    • Gridding of satellite observations
    • Gridding of collocated data
  • Retrieve AIS
  • wavy on WEkEO
• Workshops and show cases
  • Oslo wavy workshop 2024
    • 0. checklist wavy installation
    • 1. wavy config files
    • 2. Download L3 satellite altimetry data
    • 3. Read satellite data
      • Exercise:
    • 4. access/read in-situ data
    • 5. access/read model data
    • 6. Collocating model and observations
      • Collocation of satellite and wave model
    • 7. Validate the collocated time series
    • 8. Regridding data
      • Gridding of satellite data
      • Gridding of collocated data
    • 9. Applying filters
    • 10. Saving data to netcdf
  • Vietnam Validation Workshop 2021
    • 1. wavy config files
    • 2. download L3 satellite altimetry data
    • 3. download L2P and L3 CCI multi-mission satellite altimetry data
    • 4. read satellite data
      • L3 data from cmems
    • 5. access/read model data
    • 6. collocating model and observations
      • Collocation of satellite and wave model
    • 7. dump collocation ts to a netcdf file
    • 8. validate the collocated time series
    • 9. quick look examples
    • 10. Vietnam examples
      • Add model
      • Download satellite data
      • Usage in python
      • wavyQuick use for vietnam model
  • Vietnam Validation Workshop 2022
    • 1. Collocating satellite tracks with ship route
    • 2. Collocating model output with ship route
    • 3. Comparing model, satellite and observations from the ship
  • Vietnam Validation Workshop 2022 #2
    • 1. wavy config files
    • 2. Download L3 satellite altimetry data
    • 3. Read satellite data
      • Exercise:
    • 4. access/read model data
    • 5. Collocating model and observations
      • Collocation of satellite and wave model
    • 6. Validate the collocated time series
  • Vietnam Validation Workshop 2025
    • 0. Installation of wavyopen and preparation
    • 1. Downloading data satellite data
    • 2. Process satellite data
    • 3. Add custom model to wavy
    • 4. Collocate satellite with model
    • 5. Validate with model against satellite observations
  • Vietnam Validation Workshop 2026
    • 0. Installation of wavyopen and preparation
    • 1. Downloading data satellite data
    • 2. Process satellite data
    • 3. Add custom model to wavy
    • 4. Collocate satellite with model
    • 5. Validate with model against satellite observations
  • Mozambique Validation Workshop 2023
    • 0. checklist wavy installation
    • 1. wavy config files
    • 2. Download L3 satellite altimetry data
    • 3. Read satellite data
      • Exercise:
    • 4. Define your own region
    • 5. access/read model data
    • 6. Collocating model and observations
      • Collocation of satellite and wave model
    • 7. Validate the collocated time series
    • 8. Collocate and validate 10m model wind using wind from satellite altimeters
  • Mozambique Validation Workshop 2024
    • 0. wavy installation
    • 1. wavy config files
    • 2. Download L3 satellite altimetry data
    • 3. Read satellite data
    • 4. Define your own region
    • 5. access/read model data
    • 6. Collocating model and observations
      • Collocation of satellite and wave model
    • 7. Validate the collocated time series
  • Mozambique WEkEO workshop 2025
    • wavy installation on WEkEO
    • wavy config files and environment
    • Downloading data satellite data
    • Process satellite data
  • Tanzania WEkEO workshop 2025
    • wavy installation on WEkEO
    • wavy config files and environment
    • Downloading data satellite data
    • Process satellite data
• One Ocean Expedition
  • 1. Collocating satellite tracks with drifter
  • 2. Collocating model output with drifter
• wavy usage examples
  • Scientific papers that used wavy
  • PhD thesis with wavy
  • Master thesis using wavy
  • Copernicus CMEMS Product Quality Documents QuID
  • Internal usage at MET Norway
  • Educational use at University of Bergen (UiB)
  • Public operational validation tasks using wavy
  • wavy-based operational validation and education via capacity building project SAREPTA
  • Projects wavy is/was contributing to
  • Selected external entities that have used or use wavy
• Gallery
• API Reference
  • wavy
    • Submodules
      • wavy.GPfcts
      • wavy.ais_module
      • wavy.apps
      • wavy.collocation_module
      • wavy.consolidate
      • wavy.credentials
      • wavy.filter_module
      • wavy.grid_readers
      • wavy.grid_stats
      • wavy.gridder_module
      • wavy.init_class_insitu
      • wavy.init_class_mod
      • wavy.init_class_sat
      • wavy.insitu_collectors
      • wavy.insitu_module
      • wavy.insitu_readers
      • wavy.model_module
      • wavy.model_readers
      • wavy.multiins
      • wavy.multisat_module
      • wavy.ncmod
      • wavy.quicklookmod
      • wavy.satellite_collectors
      • wavy.satellite_module
      • wavy.satellite_readers
      • wavy.triple_collocation
      • wavy.utils
      • wavy.validationmod
      • wavy.wconfig
    • Classes
    • Package Contents
      • sc
      • ms
      • mc
      • ic
      • cc
      • cs
      • pc
      • gc

Indices and tables

• Index

• Search Page

• API Reference