deltares-wave-toolbox 1.1.0rc0

A Python toolbox for wave analysis

Deltares Wave Toolbox

A Python toolbox for wave analysis

Features

From a time series of water level elevations, the toolbox can calculate:

• the wave spectrum

• spectral wave parameters such as wave heigth and different wave periods

• wave height exceedance curves

• theoretical wave spectra and wave height distributions

• linear decomposition into incoming and reflected waves (using multiple wave gauges)

How to install the toolbox?

The package is available at pip. To install the package run:

pip install deltares-wave-toolbox

Where to find information about the Deltares Wave Toolbox?

See the online manual for information about the toolbox. In addition, the examples folder contains scripts with applications of the toolbox and a Jupyter notebook is available in the documentation folder.

Credits

• Jan Kramer <[e-mail]>

• Menno de Ridder <[e-mail]>

• Ivo van der Werf <[e-mail]>

• Joost den Bieman <[e-mail]>

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

1.1.0 (2024-XX-XX)

• “Rogue” release

• Python 3.9 support dropped (due to issues with scipy)

• Python 3.13 support added

• Added feature: wave decomposition into incoming and reflected waves (cores.core_wave_decomposition.decompose_linear_ZS_series)

• Added feature: calculate wave steepness and high or low-frequency wave parameters (Spectrum)

1.0.0 (2023-10-27)

• Initial “Swell” release