Skip to content

A Python package for analyzing wave data using spectral analysis and three-gauge array techniques. It separates incident and reflected waves, calculates key wave parameters, and performs zero-crossing analysis to extract significant wave heights and periods. Designed for coastal and ocean engineering applications.

License

Notifications You must be signed in to change notification settings

sandslamsal/WaveLabX

Repository files navigation

WaveLabX

DOI

WaveLabX

WaveLabX is an open-source Python toolkit for laboratory wave-probe analysis, providing reproducible wave statistics and incident–reflected decomposition.

  • Zero-crossing wave statistics from single-probe records
  • Two-probe Goda–Suzuki frequency-domain decomposition
  • Three-probe redundant-array decomposition with validity filtering

WaveLabX workflow and architecture

Installation

Recommended: use a Python virtual environment.

python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Minimal usage

import wavelabx
# See run_wavelabx_example.ipynb for a full demonstration

Files included

  • wavelabx/ — package source (API documented in docstrings)
  • run_wavelabx_example.ipynb — example notebook
  • wavedata.csv — example dataset
  • figures/ — figures for manuscript and examples
  • paper.md, paper.bib — JOSS manuscript source

License & Citation

WaveLabX is released under the MIT License (see LICENSE).

If you use WaveLabX in published research, please cite the associated JOSS manuscript and the archived software release on Zenodo. Citation metadata is provided in CITATION.cff.

Zenodo archive DOI: https://doi.org/10.5281/zenodo.18049227

About

A Python package for analyzing wave data using spectral analysis and three-gauge array techniques. It separates incident and reflected waves, calculates key wave parameters, and performs zero-crossing analysis to extract significant wave heights and periods. Designed for coastal and ocean engineering applications.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published