Skip to main content

Empirical wave runup models implemented in Python

Project description

Empirical wave runup models implemented in Python for coastal engineers and scientists.
https://zenodo.org/badge/180274721.svg https://img.shields.io/pypi/v/py-wave-runup.svg https://img.shields.io/travis/com/chrisleaman/py-wave-runup.svg Documentation Status https://codecov.io/gh/chrisleaman/py-wave-runup/branch/master/graph/badge.svg https://img.shields.io/badge/code%20style-black-000000.svg

Contents

Installation

Installation of py-wave-runup can be done with pip:

pip install py-wave-runup

Usage

The following wave runup models are available for use:

  • models.Stockdon2006: The most commonly cited and widely used runup model.

  • models.Power2018: Based on the Gene-Expression Programming technique.

  • models.Holman1986: Incorporated wave setup using Duck, NC measurements.

  • models.Nielsen2009: Based on runup measurements from NSW, Australia.

  • models.Ruggiero2001: Based on runup measurements from dissipative Orgeon beaches.

  • models.Vousdoukas2012: Based on runup from European Atlantic coast

  • models.Senechal2011: Based on extreme storm condition at Truc Vert, France

  • models.Beuzen2019: Gaussian Process (GP) runup model

  • models.Passarella2018: Genetic Programming (infragravity and total) swash model

To get calculate runup, setup and swash, define your offshore conditions in your selected runup model then you can access each parameter:

from py_wave_runup import models

model_sto06 = models.Stockdon2006(Hs=4, Tp=12, beta=0.1)

model_sto06.R2     # 2.54
model_sto06.setup  # 0.96
model_sto06.sinc   # 2.06
model_sto06.sig    # 1.65

Documentation

Documentation is located at https://py-wave-runup.readthedocs.io.

Background

Wave runup refers to the final part of a wave’s journey as it travels from offshore onto the beach. It is observable by anyone who goes to the beach and watches the edge of the water “runup” and rundown the beach. It is comprised of two components:

  • setup: the height of the time averaged superelevation of the mean water level above the Still Water Level (SWL)

  • swash: the height of the time varying fluctuation of the instantaneous water level about the setup elevation

Setup, swash and other components of Total Water Level (TWL) rise are shown in this handy figure below.

https://raw.githubusercontent.com/chrisleaman/py-wave-runup/master/docs/_static/VitousekDoubling2017Fig1.jpg
Figure from Vitousek et al. (2017) [1]

Wave runup can contribute a significant portion of the increase in TWL in coastal storms causing erosion and inundation. For example, Stockdon et al. (2006) [2] collated data from numerous experiments, some of which showed wave runup 2% excedence heights in excess of 3 m during some storms.

Given the impact such a large increase in TWL can have on coastlines, there has been much research conducted to try improve our understanding of wave runup processes. Although there are many processes which can influence wave runup (such as nonlinear wave transformation, wave reflection, three-dimensional effects, porosity, roughness, permeability and groundwater) [3], many attempts have been made to derive empirical relatinoships based on easily measurable parameters. Typically, empirical wave runup models include:

  • Hs: significant wave height

  • Tp: peak wave length

  • beta: beach slope

This python package attempts to consolidate the work done by others in this field and collate the numerous empirical relationships for wave runup which have been published.

Contributing

As there are many different empirical wave models out there, contributions are most welcome. If you don’t feel confident about changing the code yourself, feel free to open a Github issue and let us know what could be added. Otherwise, follow the steps below to create a Pull Request:

  1. Fork it (https://github.com/chrisleaman/py-wave-runup/fork)

  2. Create the development environment:

    • For pip, run pip install --pre -r requirements.txt

    • For poetry, run poetry install

    • For anaconda, run conda env create --name <env_name> -f environment.yml

  3. Create your feature branch (git checkout -b feature/fooBar)

  4. Install pre-commit hooks for automatic formatting (pre-commit run -a)

  5. Add your code!

  6. Add and run tests (pytest)

  7. Update and check documentation compiles (sphinx-build -M html ".\docs" ".\docs\_build")

  8. Commit your changes (git commit -am 'Add some fooBar)

  9. Push to the branch (git push origin feature/fooBar)

  10. Create a new Pull Request

Citation

If this package has been useful to you, please cite the following DOI: https://doi.org/10.5281/zenodo.2667464

License

Distributed under the GNU General Public License v3.

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py-wave-runup-0.1.10.tar.gz (734.9 kB view details)

Uploaded Source

Built Distribution

py_wave_runup-0.1.10-py3-none-any.whl (731.0 kB view details)

Uploaded Python 3

File details

Details for the file py-wave-runup-0.1.10.tar.gz.

File metadata

  • Download URL: py-wave-runup-0.1.10.tar.gz
  • Upload date:
  • Size: 734.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.8.0 Linux/4.15.0-1028-gcp

File hashes

Hashes for py-wave-runup-0.1.10.tar.gz
Algorithm Hash digest
SHA256 1a7e91103bf32124fcd37682627ecedd467f9100f877cba27db391068515089a
MD5 1c2552f4ebe163895fd294fb07901397
BLAKE2b-256 6320919a26526b2a1fb500b30400de46fb4314b13747259eac24904b795545c7

See more details on using hashes here.

File details

Details for the file py_wave_runup-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: py_wave_runup-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 731.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.8.0 Linux/4.15.0-1028-gcp

File hashes

Hashes for py_wave_runup-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 0fdeec77c69fb6fa6ce1f25f2a53c9449ced6a3caafc302dfd4f973565df4239
MD5 c0a6e40baba9134d7fed0c4e1a10bd05
BLAKE2b-256 e76618b394d14b5e7a28963a14a0164d3ec3ba50bcf1e41d60aeb319eea6cc0a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page