EWDM: Extended Wavelet Directional Method

Welcome to the GitHub repository for the Extended Wavelet Directional Method (EWDM) - a toolkit for estimating directional spectra of ocean waves using the Continuous Wavelet Transform (CWT).

This package implements the algorithms of the original WDM proposed by Donelan et al. (1985) that are suitable for spatially-distributed arrays of wave staffs; as well as the algorithms presented by Peláez-Zapata et al. (2024) and Krogstad et al. (2006), for single-point triplets of wave-induced displacements, velocities, accelerations or slopes.

Therefore, EWDM allows the estimation of the directional wave spectrum for variety of sources, including GPS-based buoys, pitch-roll-heave buoys, acoustic Doppler current profilers (ADCP) and sampled points from stereo-imaging recordings.

Key features of the EWDM include:

• Implementation of the wavelet-based algorithms for extracting directional information from wave time series.
• Tools for processing and visualising directional wave data.
• Powered by xarray labelled multi-dimensional arrays.
• Helper functions to handle commonly used data sources such as Spotter buoys and CDIP.
• Documentation, examples, and comparison with conventional methods.

Whether you are a researcher, student, or engineer in physical oceanography, EWDM provides a powerful, user-friendly toolkit for in-depth analysis of directional ocean wave spectra. We welcome contributions, feedback, and collaboration from the community to further enhance the capabilities of EWDM.

Getting Started

Installation

Stable release

You can install EWDM using pip. First, make sure you have Python 3.8 or higher installed.

pip install ewdm

This is the preferred method to install EWDM, as it will always install the most recent stable release.

If you don't have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for EWDM can be downloaded from the Github repo.

You can either clone the public repository:

git clone git://github.com/dspelaez/extended-wdm

Or download the tarball:

curl -OJL https://github.com/dspelaez/extended-wdm/tarball/master

Once you have a copy of the source, you can install it with:

python setup.py install

Or using pip:

pip install .

Running tests

To install the necessary packages for development and testing, you can run the following command:

pip install -e '.[test]'

To run the tests, you can use the pytest framework by executing the following command:

pytest tests

Usage

After installation, you can import and use the ewdm package in your Python code:

import ewdm

Quick example

This example uses a CDIP buoy time series of wave-induced displacements to estimate the directional wave spectrum.

import numpy as np
import xarray as xr
from matplotlib import pyplot as plt

import ewdm
from ewdm.sources import CDIPDataSourceRealTime
from ewdm.plots import plot_directional_spectrum
plt.ion()

cdip =  CDIPDataSourceRealTime(166)
dataset = cdip.read_dataset(time_start='2024-06-09T08:30')
spec = ewdm.Triplets(dataset)
output = spec.compute()

fig, ax = plt.subplots()
plot_directional_spectrum(
    output["directional_spectrum"], ax=ax, levels=None
)

This will produce a plot like this:

Further examples

For a curated collection of examples, please refer to the Gallery in the documentation.

Related projects

Several tools complement the functionality of EWDM in the analysis of ocean wave data. Some of the most relevant projects are:

• WAFO provides advanced statistical and engineering analysis of wave fields and wave-induced loads.

• FOWD offers a rich dataset of wave parameters tailored for machine learning applications. It also provides routines to compute frequently used wave parameters.

• DIWASP implements classical Fourier-based methods for directional spectrum estimation.

• Special mention to modern Python packages like wavespectra and oceanwaves-python, that support spectral data manipulation and visualization. While these tools do not estimate directional spectra from raw measurements, they can be integrated with EWDM to enhance wave data processing workflows.

How to cite this work

If you find this package useful, please consider citing the package using the DOI: 10.5281/zenodo.12805995

How to contribute

EWDM is an open-source package and we welcome feedback and contributions.

You can open an issue in the GitHub issues page if you:

• find a bug in the package;
• need some new features;
• want some supports;
• show your own examples.

Please refer to the Contributing guide in the documentation for further information.