wolfhece.PyHydrographs

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

class wolfhece.PyHydrographs.Constants[source]

Bases: enum.Enum

Inheritance diagram of wolfhece.PyHydrographs.Constants

Contain the constants used throughout the module.

SEPARATOR = '\t'[source]
class wolfhece.PyHydrographs.Hydrograph(data=None, index=None, dtype=None, name='Discharge', copy=None, file_path: str = '', fastpath=False)[source]

Bases: pandas.Series

Inheritance diagram of wolfhece.PyHydrographs.Hydrograph

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.

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

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

read_from_wolf_file(file_path: str, separator: Literal, [;, ]= Constants.SEPARATOR.value) → dict[source]

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.