wolfhece.PyHydrographs
======================

.. py:module:: wolfhece.PyHydrographs

.. autoapi-nested-parse::

   Author: HECE - University of Liege, Pierre Archambeau, Utashi Ciraane Docile
   Date: 2024

   Copyright (c) 2024 University of Liege. All rights reserved.

   This script and its content are protected by copyright law. Unauthorized
   copying or distribution of this file, via any medium, is strictly prohibited.





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

.. py:class:: Constants(*args, **kwds)

   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: wolfhece.PyHydrographs.Constants
      :parts: 1
      :private-bases:


   Contain the constants used throughout
   the module.


   .. py:attribute:: SEPARATOR
      :value: '\t'



.. py:class:: Hydrograph(data=None, index=None, dtype=None, name='Discharge', copy=None, file_path: str = '')

   Bases: :py:obj:`pandas.Series`

   .. autoapi-inheritance-diagram:: wolfhece.PyHydrographs.Hydrograph
      :parts: 1
      :private-bases:


   A pandas series containing discharges (values)
   with their respective times of observation (indices).

   @ The class is inherited which means
   all series method are available in this
   class escorted by a few other functions useful in
   the interaction with wolfhece tools.



   .. py:method:: write_as_wolf_file(file_path: str, writing_method: Literal['continuous', 'stepwise'] = 'continuous', epsilon: float = 1.0)

      Write the hydrograph on the infiltration format
      of wolf models -> infil[n].tv file.



   .. py:method:: read_from_wolf_file(file_path: str, separator: Literal[',', ';', '\t'] = Constants.SEPARATOR.value) -> dict

      Read a wolf file at the format infil[n].tv and
      return its data as a dictionnary where:
       - keys are times and,
       - values are discharges.