Python Wave Runup
=================


.. image:: https://img.shields.io/pypi/v/py-wave-runup.svg
        :target: https://pypi.python.org/pypi/py-wave-runup

.. image:: https://img.shields.io/travis/com/chrisleaman/py-wave-runup.svg
        :target: https://travis-ci.com/chrisleaman/py-wave-runup

.. image:: https://readthedocs.org/projects/py-wave-runup/badge/?version=latest
    :target: https://py-wave-runup.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://codecov.io/gh/chrisleaman/py-wave-runup/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/chrisleaman/py-wave-runup

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/ambv/black

.. image:: https://api.dependabot.com/badges/status?host=github&identifier=180274721
     :target: https://dependabot.com
     :alt: Updates

**py-wave-runup** is a Python module which makes it easy for coastal engineers and
scientists to test and use various empirical wave runup models which have been
published in literature.

To get started, check out the sections below:

Contents
~~~~~~~~

.. toctree::
   :maxdepth: 2

   background
   installation
   usage
   models
   ensembles
   datasets
   auto_examples/index