:py:mod:`digger.analyze.splash_points`
======================================

.. py:module:: digger.analyze.splash_points

.. autodoc2-docstring:: digger.analyze.splash_points
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`splash <digger.analyze.splash_points.splash>`
     - .. autodoc2-docstring:: digger.analyze.splash_points.splash
          :summary:

API
~~~

.. py:function:: splash(data_path: str, output_type: str = 'fgout', out_path: str = 'time_distance_array.csv', offshore_buffer: float = 0, routing: str = 'd8', fig_dir: str = '.', fig_stem: str = 'scenario', plots: bool = True, initial_landslide=None) -> None
   :canonical: digger.analyze.splash_points.splash

   .. autodoc2-docstring:: digger.analyze.splash_points.splash