Welcome to pybeach's documentation!
===================================

.. image:: https://www.repostatus.org/badges/latest/active.svg
   :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.
   :target: https://www.repostatus.org/#active

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT
    :alt: License

.. image:: https://readthedocs.org/projects/pybeach/badge/?version=latest
    :target: https://pybeach.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://codecov.io/gh/TomasBeuzen/pybeach/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/TomasBeuzen/pybeach
    :alt: Code Coverage

.. image:: https://joss.theoj.org/papers/8b211e45c6919ea8057946484e757c28/status.svg
    :target: https://joss.theoj.org/papers/8b211e45c6919ea8057946484e757c28
    :alt: JOSS

.. image:: https://badge.fury.io/py/pybeach.svg
    :alt: PyPi

.. image:: https://github.com/TomasBeuzen/pybeach/workflows/build/badge.svg?branch=master
    :alt: Build

**pybeach** is a Python package for locating the dune toe on cross-shore beach profile transects. 

.. image:: ./_static/figure_1.png
..

    | Example application of **pybeach**.

Contents
~~~~~~~~

.. toctree::
   :maxdepth: 2

   background
   installation
   usage
   help

..