ripplemapper Documentation
--------------------------

This is the documentation for ripplemapper.


``ripplemapper`` is a free and open-source package for Python.
It provides an interface for reading in and processing images of water-air interface to detect the breaking of waves.

.. grid:: 1 1 2 2
    :gutter: 1

    .. grid-item-card:: Tutorial
        :link: tutorial
        :link-type: ref
        :text-align: center

        :material-outlined:`accessibility_new;8em;sd-text-secondary`

        **New users start here!**
        Walkthrough on how to install ripplemapper and get to grips with the basics.

    .. grid-item-card:: Example gallery
        :link: generated/gallery/index.html
        :text-align: center

        :material-outlined:`palette;8em;sd-text-secondary`

        Examples of ``ripplemapper`` in action.


    .. grid-item-card:: Reference
        :link-type: ref
        :link: reference
        :text-align: center

        :material-outlined:`code;8em;sd-text-secondary`

        Technical description of the inputs, outputs, and behavior of each part of ``ripplemapper``.

.. toctree::
    :maxdepth: 2
    :hidden:

    tutorial/index
    generated/gallery/index
    reference/index