==============
Documentation
==============

Spatial pre-processing functions
-------

.. automodule:: wavebreaking.processing.spatial
   :members:
   :undoc-members:
   :show-inheritance:
   
Indices
-------

.. automodule:: wavebreaking.indices.contour_index
   :members:
   :undoc-members:
   :show-inheritance:
   :exclude-members: decorator_contour_calculation
   
.. automodule:: wavebreaking.indices.streamer_index
   :members:
   :undoc-members:
   :show-inheritance:
   
.. automodule:: wavebreaking.indices.overturning_index
   :members:
   :undoc-members:
   :show-inheritance:
   
.. automodule:: wavebreaking.indices.cutoff_index
   :members:
   :undoc-members:
   :show-inheritance:
   
Events post-processing functions
-------

.. automodule:: wavebreaking.processing.events
   :members:
   :undoc-members:
   :show-inheritance:
   
Plotting functions
-------

.. automodule:: wavebreaking.processing.plots
   :members:
   :undoc-members:
   :show-inheritance: