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

.. py:module:: digger.analyze.energetics

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

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

Functions
~~~~~~~~~

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

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

API
~~~

.. py:function:: energetics(wdir: str = '.', output_type: str = 'fgout', gdir: str = '_output', csvout: str = 'energetics.csv', mthresh: float = 0.3, gravity: float = 9.81, phi: float = 38.0, rho_s: float = 2700, rho_f: float = 1000, drytolerance: float = 0.001, sealevel: float = 0, east: float = None, west: float = None, south: float = None, north: float = None, plot: float = True, plot_tmax: None | float = 60, bing: bool = False, epsg: int = None, yaml_out: str = 'energetics.yaml') -> dict
   :canonical: digger.analyze.energetics.energetics

   .. autodoc2-docstring:: digger.analyze.energetics.energetics