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.

Tutorial

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

The ripplemapper Tutorial
Example gallery

Examples of ripplemapper in action.

generated/gallery/index.html
Reference

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

Reference