wolfhece 2.2.7__py3-none-any.whl → 2.2.9__py3-none-any.whl

wolfhece/hydrology/Internal_variables.py

@@ -0,0 +1,283 @@
+from __future__ import annotations
+from typing import Optional
+from os.path import exists, join
+import numpy as np
+import logging
+from datetime import datetime as date
+from datetime import timezone
+from dataclasses import dataclass
+from . import read as rd
+from ..PyParams import Wolf_Param
+
+ALL_VAR = 0
+IV_VAR = 1
+FRAC_VAR = 2
+FINAL_OUT_VAR = 3
+OUT_VAR = 4
+DEFAULT_VAR = 5
+
+
+@dataclass(frozen=True)
+class Internal_Variable:
+    """
+    Class for managing internal variables in hydrological models.
+    """
+    name:str
+    file:str
+    type_of_var:int
+    linked_param:int
+
+
+    def get_time_serie(self, directory, prefix_file:str="", 
+                       interval:Optional[tuple[date, date]]=None) -> tuple[np.ndarray, np.ndarray]:
+        """
+        Get the time series of the internal variable.
+
+        :param interval: Optional interval for the time series.
+        :return: Time series of the internal variable.
+        """
+        filename, full_path = self.get_filename(directory, prefix=prefix_file)
+        if filename is None:
+            return None, None
+        time, cur_iv = rd.read_hydro_file(directory, fileName=filename)
+        # select the interval if needed
+        if interval is not None:
+            # Check if the datetime in interva are in UTC timezone
+            if interval[0].tzinfo == timezone.utc or interval[1].tzinfo == timezone.utc:
+                interval = (interval[0].replace(tzinfo=timezone.utc),
+                            interval[1].replace(tzinfo=timezone.utc))
+                t_start = interval[0].timestamp()
+                t_end = interval[1].timestamp()
+                time = time[(time >= t_start) & (time <= t_end)]
+                cur_iv = cur_iv[(time >= t_start) & (time <= t_end)]
+            else:
+                logging.error("Interval is not in UTC timezone!")
+
+        return time, cur_iv
+
+
+    def get_filename(self, directory:str, prefix:str="")->tuple[str, str]:
+        """
+        Get the filename of the internal variable.
+
+        :param directory: Directory where the file is located.
+        :param prefix: Prefix for the filename.
+        :return: Tuple containing the name of the file only and the full path of the internal variable.
+        """
+        filename = "".join([prefix,"_", self.file, ".dat"])
+        full_path = join(directory, filename)
+        # check if the file exists
+        if not exists(full_path):
+            logging.error(f"File {full_path} not found!")
+            return None, None
+
+        return filename, full_path
+
+
+# @dataclass(frozen=True)
+class Param_to_Activate:
+    """
+    Class for managing parameters to activate in hydrological models.
+    """
+    key: str
+    group: str
+    file: str
+    all_variables: list[Internal_Variable]
+
+    def __init__(self, key:str="", group:str="", file:str="", all_variables:list[Internal_Variable]=[]):
+        """
+        Initialize the Params_to_Activate class with parameters for different models.
+        """       
+        self.key = key
+        self.group = group
+        self.file = file
+        self.all_variables = all_variables
+
+    def add_param_info(self, key:str, group:str, file:str):
+        """
+        Add parameter information to the class.
+        """
+        self.key = key
+        self.group = group
+        self.file = file
+
+    def check_param_file(self, directory:str):
+        """
+        Define the working directory for the parameters.
+        """
+        cur_file = join(directory, self.file)
+        # check if the file exists
+        if not exists(cur_file):
+            logging.error(f"File {cur_file} not found!")
+            
+    def add_variable(self, variable:Internal_Variable|list[Internal_Variable]):
+        """
+        Add one or a list of internal variable(s) to the list of variables.
+        """
+        if isinstance(variable, list):
+            self.all_variables += variable
+        else:
+            self.all_variables.append(variable)
+        
+    def get_variables_names(self) -> list[str]:
+        """
+        Get the names of the internal variables.
+        """
+        return [var.name for var in self.all_variables]
+    
+    def get_variables_files(self) -> list[str]:
+        """
+        Get the files of the internal variables.
+        """
+        return [var.file for var in self.all_variables]
+    
+    def activate(self, directory:str, prefix_file:str="", type_of_var:int=ALL_VAR):
+        """
+        Activate the parameters for the internal variables.
+        """
+        if self.key is None or self.group is None:
+            return
+        
+        to_activate = False
+        if type_of_var == ALL_VAR:
+            to_activate = True
+        else:
+            for var in self.all_variables:
+                if var.type_of_var == type_of_var or type_of_var == ALL_VAR:
+                    to_activate = True
+                    break
+
+        if to_activate:
+            new_prefix = self._build_prefix(prefix_file)
+            filename = ".".join([new_prefix,"param"])
+            param_filename = join(directory, filename)            
+            param_file = Wolf_Param(to_read=True, filename=param_filename,toShow=False, init_GUI=False)
+            param_file.change_param(self.group, self.key, 1)
+            param_file.SavetoFile(None)
+            param_file.Reload(None)
+        else:
+            self.deactivate(directory, prefix_file)
+
+    def deactivate(self, directory:str, prefix_file:str=""):
+        """
+        Deactivate the parameters for the internal variables.
+        """
+        new_prefix = self._build_prefix(prefix_file)
+        filename = ".".join([new_prefix,"param"])
+        param_filename = join(directory, filename)
+        param_file = Wolf_Param(to_read=True, filename=param_filename,toShow=False, init_GUI=False)
+        param_file.change_param(self.group, self.key, 0)
+        param_file.SavetoFile(None)
+        param_file.Reload(None)
+
+    def get_iv_timeseries(self, directory:str, prefix_file:str="", interval:Optional[tuple[date, date]]=None, type_of_var:int=ALL_VAR) -> dict[str, np.ndarray]:
+        """
+        Get the time series of the internal variables.
+
+        :param directory: Directory where the file is located.
+        :param prefix_file: Prefix for the filename.
+        :param interval: Optional interval for the time series.
+        :return: List of tuples containing the time and internal variable data.
+        """
+
+        new_prefix = self._build_prefix(prefix_file)
+
+        all_timeseries = {var.name: 
+                          var.get_time_serie(directory, new_prefix, interval)[1]
+                          for var in self.all_variables 
+                          if var.type_of_var == type_of_var or type_of_var == ALL_VAR}
+
+        return all_timeseries
+    
+
+    def get_linked_params(self) -> dict[str, int]:
+        """
+        Get the linked parameters of the internal variables.
+
+        :return: Dictionary of linked parameters.
+        """
+        return {var.name: var.linked_param for var in self.all_variables if var.linked_param is not None}
+    
+    def _build_prefix(self, prefix_file:str) -> str:
+        """
+        Build the prefix for the filename.
+
+        :param prefix_file: Prefix for the filename.
+        :return: Prefix for the filename.
+        """
+        if self.file == "":
+            return prefix_file
+        else:
+            return "_".join([prefix_file, self.file])
+    
+
+
+class Group_to_Activate:
+    """
+    Class for managing groups of parameters to activate in hydrological models.
+    """
+    name: str
+    all_params: list[Param_to_Activate]
+
+    def __init__(self, name:str="", all_params:list[Param_to_Activate]=[]):
+        """
+        Initialize the Group_to_Activate class with parameters for different models.
+        """       
+        self.name = name
+        self.all_params = all_params
+
+    def get_keys(self) -> list[str]:
+        """
+        Get the keys of the parameters.
+        """
+        return [param.key for param in self.all_params]
+
+    def get_files_per_keys(self) -> list[str]:
+        """
+        Get the files of the parameters.
+        """
+        return [param.get_variables_files() for param in self.all_params]
+
+    def activate_all(self, directory:str, prefix_file:str="", type_of_var:int=ALL_VAR):
+        """
+        Activate all parameters in the group.
+        """
+        for param in self.all_params:
+            param.activate(directory, prefix_file, type_of_var)
+
+    def deactivate_all(self, directory:str, prefix_file:str=""):
+        """
+        Deactivate all parameters in the group.
+        """
+        for param in self.all_params:
+            param.deactivate(directory, prefix_file)
+
+    def get_all_iv_timeseries(self, directory:str, prefix_file:str="",
+                              interval:Optional[tuple[date, date]]=None,
+                              type_of_var:int=ALL_VAR) -> dict[str, np.ndarray]:
+        """
+        Get the time series of all internal variables in the group.
+
+        :param directory: Directory where the file is located.
+        :param prefix_file: Prefix for the filename.
+        :param interval: Optional interval for the time series.
+        :return: List of tuples containing the time and internal variable data.
+        """
+        all_timeseries = {}
+        for param in self.all_params:
+            all_timeseries.update(param.get_iv_timeseries(directory, prefix_file,
+                                                          interval, type_of_var))
+
+        return all_timeseries
+    
+    def get_all_linked_params(self) -> dict[str, int]:
+        """
+        Get the linked parameters of the internal variables.
+
+        :return: Dictionary of linked parameters.
+        """
+        all_linked_params = {}
+        for param in self.all_params:
+            all_linked_params.update(param.get_linked_params())
+
+        return all_linked_params

wolfhece/hydrology/Models_characteristics.py

@@ -0,0 +1,223 @@
+from . import constant as cst
+from . import cst_exchanges as cste
+from . import Internal_variables as iv
+
+VHM_VAR = iv.Group_to_Activate(
+    name="VHM",
+    all_params=[
+        iv.Param_to_Activate(
+            key="x", group="Internal variables to save", file="soil", 
+            all_variables=[
+                iv.Internal_Variable(name=f"%xu", file="xu", type_of_var=iv.FRAC_VAR, linked_param=None),
+                iv.Internal_Variable(name=f"%xof", file="xof", type_of_var=iv.FRAC_VAR, linked_param=None),
+                iv.Internal_Variable(name=f"%xif", file="xif", type_of_var=iv.FRAC_VAR, linked_param=None),
+                iv.Internal_Variable(name=f"%xbf", file="xbf", type_of_var=iv.FRAC_VAR, linked_param=None),
+            ]),
+        iv.Param_to_Activate(
+            key="U", group="Internal variables to save", file="soil",
+            all_variables=[
+                iv.Internal_Variable(name="U", file="U", type_of_var=iv.IV_VAR, 
+                                     linked_param=cste.exchange_parameters_VHM_Umax)
+            ]),
+        iv.Param_to_Activate(
+            key=None, group=None, file="",
+            all_variables=[
+                iv.Internal_Variable(name="q_of", file="of", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_if", file="if", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_bf", file="bf", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+            ])
+    ])
+
+
+UHDIST_LINBF_VAR = iv.Group_to_Activate(
+    name="2 layers",
+    all_params=[
+        iv.Param_to_Activate(
+            key="x", group="Internal variables to save", file="soil",
+            all_variables=[
+                iv.Internal_Variable(name=f"% xif", file="x", type_of_var=iv.FRAC_VAR, linked_param=None)
+            ]),
+        iv.Param_to_Activate(
+            key="U", group="Internal variables to save", file="soil",
+            all_variables=[
+                iv.Internal_Variable(name=f"%U", file="U", type_of_var=iv.IV_VAR, 
+                                     linked_param=cste.exchange_parameters_Dist_Soil_Umax)
+            ]),
+        iv.Param_to_Activate(
+            key="Reservoir", group="Internal variables to save", file="soil",
+            all_variables=[
+                iv.Internal_Variable(name=f"% xp", file="xp", type_of_var=iv.FRAC_VAR, linked_param=None),
+                iv.Internal_Variable(name=f"S", file="S", type_of_var=iv.IV_VAR, 
+                                     linked_param=cste.exchange_parameters_Dist_RS_Hs)
+            ]),
+        iv.Param_to_Activate(
+            key=None, group=None, file="",
+            all_variables=[
+                iv.Internal_Variable(name="q_of", file="of", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_if", file="if", type_of_var=iv.DEFAULT_VAR, linked_param=None)
+            ])
+    ]
+)
+
+
+HBV_VAR = iv.Group_to_Activate(
+    name="HBV",
+    all_params=[
+        iv.Param_to_Activate(
+            key="U", group="Internal variables to save", file="soil",
+            all_variables=[
+                iv.Internal_Variable(name="U", file="U", type_of_var=iv.IV_VAR, 
+                                     linked_param=cste.exchange_parameters_HBV_FC),
+            ]),
+        iv.Param_to_Activate(
+            key="Q out", group="Internal variables to save", file="soil",
+            all_variables=[
+                iv.Internal_Variable(name="q recharge", file="qrech", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q capillary", file="qcap", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="Evapotranspiration", file="etr", type_of_var=iv.OUT_VAR, linked_param=None)
+            ]),
+        iv.Param_to_Activate(
+            key="Su", group="Internal variables to save", file="UZ",
+            all_variables=[
+                iv.Internal_Variable(name="Su", file="Su", type_of_var=iv.IV_VAR, 
+                                     linked_param=cste.exchange_parameters_HBV_SUmax)
+            ]),
+        iv.Param_to_Activate(
+            key="Q out", group="Internal variables to save", file="UZ",
+            all_variables=[
+                iv.Internal_Variable(name="q_of", file="qr", type_of_var=iv.FINAL_OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_if", file="qif", type_of_var=iv.FINAL_OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q percolation", file="qperc", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q cap UZ", file="qcap", type_of_var=iv.OUT_VAR, linked_param=None)
+            ]),
+        iv.Param_to_Activate(
+            key=None, group=None, file="",
+            all_variables=[
+                iv.Internal_Variable(name="q_bf", file="bf", type_of_var=iv.DEFAULT_VAR, linked_param=None)
+            ])
+    ]
+)
+
+SACSMA_VAR = iv.Group_to_Activate(
+    name="SAC-SMA",
+    all_params=[
+        iv.Param_to_Activate(
+            key="IV", group="Internal variables to save", file="UZ",
+            all_variables=[
+                iv.Internal_Variable(name="C_UZ_TW", file="Ctw", type_of_var=iv.IV_VAR, 
+                                     linked_param=cste.exchange_parameters_SAC_M_UZ_TW),
+                iv.Internal_Variable(name="C_UZ_FW", file="Cfw", type_of_var=iv.IV_VAR,
+                                     linked_param=cste.exchange_parameters_SAC_M_UZ_FW),
+                iv.Internal_Variable(name="C_Adimp", file="Cadimp", type_of_var=iv.IV_VAR, linked_param=None)
+            ]),
+        iv.Param_to_Activate(
+            key="Q out", group="Internal variables to save", file="UZ",
+            all_variables=[
+                iv.Internal_Variable(name="E1", file="e1", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="E2", file="e2", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="E5", file="e5", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_ft", file="qft", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_tf", file="qtf", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_if", file="qif", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_perc", file="qperc", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_sr", file="qsr", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_in Adimp", file="qinadimp", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_dr Adimp", file="qdr", type_of_var=iv.OUT_VAR, linked_param=None)
+            ]),
+        iv.Param_to_Activate(
+            key="IV", group="Internal variables to save", file="LZ",
+            all_variables=[
+                iv.Internal_Variable(name="C_LZ_TW", file="Ctw", type_of_var=iv.IV_VAR, 
+                                     linked_param=cste.exchange_parameters_SAC_M_LZ_TW),
+                iv.Internal_Variable(name="C_LZ_FP", file="Cfp", type_of_var=iv.IV_VAR, 
+                                     linked_param=cste.exchange_parameters_SAC_M_LZ_FP),
+                iv.Internal_Variable(name="C_LZ_FS", file="Cfs", type_of_var=iv.IV_VAR,
+                                     linked_param=cste.exchange_parameters_SAC_M_LZ_FS)
+            ]),
+        iv.Param_to_Activate(
+            key="Q out", group="Internal variables to save", file="LZ",
+            all_variables=[
+                iv.Internal_Variable(name="E3", file="e3", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_fp", file="qfp", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_fs", file="qfs", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_in tw", file="qintw", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_in fp", file="qinfp", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_in fs", file="qinfs", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_out tw", file="qouttw", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_out fp", file="qoutfp", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_out fs", file="qoutfs", type_of_var=iv.OUT_VAR, linked_param=None),
+            ]),
+        iv.Param_to_Activate(
+            key=None, group=None, file="out",
+            all_variables=[
+                iv.Internal_Variable(name="E_tot", file="Etot", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="Q_of", file="Qof", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="Q_if", file="Qif", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="Q_bf", file="Qbf", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="Q_subbf", file="Qsubbf", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="Q_surf", file="Qsurf", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="Q_base", file="Qbase", type_of_var=iv.DEFAULT_VAR, linked_param=None)
+            ])
+    ]
+)
+
+NAM_VAR = iv.Group_to_Activate(
+    name="NAM",
+    all_params=[
+        iv.Param_to_Activate(
+            key="U", group="Internal variables to save", file="SS",
+            all_variables=[
+                iv.Internal_Variable(name="U", file="U", type_of_var=iv.IV_VAR, 
+                                     linked_param=cste.exchange_parameters_NAM_UMAX),
+            ]),
+        iv.Param_to_Activate(
+            key="Q out", group="Internal variables to save", file="SS",
+            all_variables=[
+                iv.Internal_Variable(name="qqof", file="qof", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="qqif", file="qif", type_of_var=iv.OUT_VAR, linked_param=None),
+                # iv.Internal_Variable(name="q_infil", file="qinfil", type_of_var=iv.OUT_VAR),
+                iv.Internal_Variable(name="Ea", file="ea", type_of_var=iv.OUT_VAR, linked_param=None),
+            ]),
+        iv.Param_to_Activate(
+            key="IV", group="Internal variables to save", file="RZ",
+            all_variables=[
+                iv.Internal_Variable(name="L", file="L", type_of_var=iv.IV_VAR,
+                                     linked_param=cste.exchange_parameters_NAM_LMAX),
+            ]),
+        iv.Param_to_Activate(
+            key="Q out", group="Internal variables to save", file="RZ",
+            all_variables=[
+                iv.Internal_Variable(name="E_rz", file="erz", type_of_var=iv.OUT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_g", file="qg", type_of_var=iv.OUT_VAR, linked_param=None),
+            ]),
+        iv.Param_to_Activate(
+            key=None, group=None, file="",
+            all_variables=[
+                iv.Internal_Variable(name="q_of", file="OF", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_if", file="IF", type_of_var=iv.DEFAULT_VAR, linked_param=None),
+                iv.Internal_Variable(name="q_bf", file="BF", type_of_var=iv.DEFAULT_VAR, linked_param=None)
+            ])
+    ]
+)
+
+
+MODELS_VAR:dict[int, iv.Group_to_Activate] = {
+    cst.tom_VHM: VHM_VAR,
+    cst.tom_2layers_linIF: UHDIST_LINBF_VAR,
+    cst.tom_HBV: HBV_VAR,
+    cst.tom_SAC_SMA: SACSMA_VAR,
+    cst.tom_NAM: NAM_VAR
+}
+
+if __name__ == "__main__":
+    print(f"VHM keys: {VHM_VAR.get_keys()}")
+    print(f"UHDIST_LINBF keys: {UHDIST_LINBF_VAR.get_keys()}")
+    print(f"HBV keys: {HBV_VAR.get_keys()}")
+    print(f"SACSMA keys: {SACSMA_VAR.get_keys()}")
+    print(f"NAM keys: {NAM_VAR.get_keys()}")
+    
+    print(f"VHM files: {VHM_VAR.get_files_per_keys()}")
+    print(f"UHDIST_LINBF files: {UHDIST_LINBF_VAR.get_files_per_keys()}")
+    print(f"HBV files: {HBV_VAR.get_files_per_keys()}")
+    print(f"SACSMA files: {SACSMA_VAR.get_files_per_keys()}")
+    print(f"NAM files: {NAM_VAR.get_files_per_keys()}")