wolfhece 2.1.128__py3-none-any.whl → 2.2.1__py3-none-any.whl

wolfhece/hydrology/cst_exchanges.py

@@ -9,49 +9,109 @@ copying or distribution of this file, via any medium, is strictly prohibited.
 """
 
 from . import constant as cst
+from enum import Enum
 # Constants representing the exchanges - Fortran
 
-exchange_parameters_VHM_Umax   = 20 #Paramètre modèle VHM
-exchange_parameters_VHM_Uevap  = 21 #Paramètre modèle VHM
-exchange_parameters_VHM_au1    = 22 #Paramètre modèle VHM
-exchange_parameters_VHM_au2    = 23 #Paramètre modèle VHM
-exchange_parameters_VHM_au3    = 24 #Paramètre modèle VHM
-exchange_parameters_VHM_aof1   = 25 #Paramètre modèle VHM
-exchange_parameters_VHM_aof2   = 26 #Paramètre modèle VHM
-exchange_parameters_VHM_aif1   = 27 #Paramètre modèle VHM
-exchange_parameters_VHM_aif2   = 28 #Paramètre modèle VHM
-exchange_parameters_VHM_kof    = 29 #Paramètre modèle VHM
-exchange_parameters_VHM_kif    = 30 #Paramètre modèle VHM
-exchange_parameters_VHM_kbf    = 31 #Paramètre modèle VHM
-exchange_parameters_GR4_x1     = 32 #Paramètre modèle GR4
-exchange_parameters_GR4_x2     = 33 #Paramètre modèle GR4
-exchange_parameters_GR4_x3     = 34 #Paramètre modèle GR4
-exchange_parameters_GR4_x4     = 35 #Paramètre modèle GR4
-exchange_parameters_VHM_UH_kif = 36 #Paramètre modèle VHM_UH
-exchange_parameters_VHM_UH_kbf = 37 #Paramètre modèle VHM_UH
-exchange_parameters_Froude_min_riv     = 101 #Paramètre modèle VHM_UH méthode de Froude
-exchange_parameters_Froude_max_riv     = 102 #Paramètre modèle VHM_UH méthode de Froude
-exchange_parameters_Froude_min_bas     = 103 #Paramètre modèle VHM_UH méthode de Froude
-exchange_parameters_Froude_max_bas     = 104 #Paramètre modèle VHM_UH méthode de Froude
-exchange_parameters_Froude_discharge   = 105 #Paramètre modèle VHM_UH méthode de Froude
-exchange_parameters_Nash_pt            = 106 #Paramètre modèle VHM_UH méthode de Nash (peak time)
-exchange_parameters_Nash_nb            = 107 #Paramètre modèle VHM_UH méthode de Nash (nb reservoirs)
-exchange_parameters_AsymTri_totTime    = 108 #Paramètre modèle VHM_UH méthode de HU triangulaire asymétrique (temps total)
-exchange_parameters_AsymTri_pt         = 109 #Paramètre modèle VHM_UH méthode de HU triangulaire asymétrique (peak time)
+exchange_parameters_VHM_Umax            = 20 #Paramètre modèle VHM
+exchange_parameters_VHM_Uevap           = 21 #Paramètre modèle VHM
+exchange_parameters_VHM_au1             = 22 #Paramètre modèle VHM
+exchange_parameters_VHM_au2             = 23 #Paramètre modèle VHM
+exchange_parameters_VHM_au3             = 24 #Paramètre modèle VHM
+exchange_parameters_VHM_aof1            = 25 #Paramètre modèle VHM
+exchange_parameters_VHM_aof2            = 26 #Paramètre modèle VHM
+exchange_parameters_VHM_aif1            = 27 #Paramètre modèle VHM
+exchange_parameters_VHM_aif2            = 28 #Paramètre modèle VHM
+exchange_parameters_VHM_kof             = 29 #Paramètre modèle VHM
+exchange_parameters_VHM_kif             = 30 #Paramètre modèle VHM
+exchange_parameters_VHM_kbf             = 31 #Paramètre modèle VHM
+exchange_parameters_GR4_x1              = 32 #Paramètre modèle GR4
+exchange_parameters_GR4_x2              = 33 #Paramètre modèle GR4
+exchange_parameters_GR4_x3              = 34 #Paramètre modèle GR4
+exchange_parameters_GR4_x4              = 35 #Paramètre modèle GR4
+exchange_parameters_VHM_UH_kif          = 36 #Paramètre modèle VHM_UH
+exchange_parameters_VHM_UH_kbf          = 37 #Paramètre modèle VHM_UH
 
-exchange_parameters_Dist_RS_Hs         = 110 #Paramètre modèle distribué Réservoir de stockage
-exchange_parameters_Dist_RS_TS         = 111 #Paramètre modèle distribué Réservoir de stockage
-exchange_parameters_Dist_Soil_Umax     = 112 #Paramètre modèle distribué Soil
-exchange_parameters_Dist_Soil_TSPAN    = 113 #Paramètre modèle distribué Soil
-exchange_parameters_Dist_Horton_F0     = 114 #Paramètre modèle distribué Horton
-exchange_parameters_Dist_Horton_FC     = 115 #Paramètre modèle distribué Horton
-exchange_parameters_Dist_Horton_K      = 116 #Paramètre modèle distribué Horton
-exchange_parameters_Dist_kif           = 117 #Paramètre modèle distribué pour réservoir linéaire couche épidermique (if)
-exchange_parameters_Dist_qlif          = 118 #Paramètre modèle distribué pour réservoir linéaire couche épidermique (if)
+exchange_parameters_HBV_FC              = 50 #Paramètre modèle HBV
+exchange_parameters_HBV_beta            = 51 #Paramètre modèle HBV
+exchange_parameters_HBV_PWP             = 52 #Paramètre modèle HBV
+exchange_parameters_HBV_SUmax           = 53 #Paramètre modèle HBV
+exchange_parameters_HBV_kr              = 54 #Paramètre modèle HBV
+exchange_parameters_HBV_kif             = 55 #Paramètre modèle HBV
+exchange_parameters_HBV_kperc           = 56 #Paramètre modèle HBV
+exchange_parameters_HBV_kbf             = 57 #Paramètre modèle HBV
+exchange_parameters_HBV_CFLUX           = 58 #Paramètre modèle HBV (HBV-96)
+exchange_parameters_HBV_alpha           = 59 #Paramètre modèle HBV (HBV-96)
+
+exchange_parameters_SAC_M_UZ_TW         = 60 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_M_UZ_FW         = 61 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_M_LZ_TW         = 62 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_M_LZ_FP         = 63 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_M_LZ_FS         = 64 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_kif             = 65 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_kbf_fp          = 66 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_kbf_fs          = 67 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_zperc           = 68 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_rexp            = 69 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_rserv           = 74 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_pfree           = 75 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_side            = 76 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_riva            = 77 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_adimp           = 78 #Paramètre modèle SAC-SMA (SACRAMENTO)
+exchange_parameters_SAC_impv            = 79 #Paramètre modèle SAC-SMA (SACRAMENTO)
+
+exchange_parameters_NAM_UMAX            = 82 #Paramètre modèle NAM
+exchange_parameters_NAM_TOF             = 83 #Paramètre modèle NAM
+exchange_parameters_NAM_TIF             = 84 #Paramètre modèle NAM
+exchange_parameters_NAM_CQOF            = 85 #Paramètre modèle NAM
+exchange_parameters_NAM_CKIF            = 86 #Paramètre modèle NAM
+exchange_parameters_NAM_LMAX            = 87 #Paramètre modèle NAM
+exchange_parameters_NAM_TG              = 88 #Paramètre modèle NAM
+exchange_parameters_NAM_CK12            = 89 #Paramètre modèle NAM
+
+exchange_parameters_NAM_CAREA           = 94 #Paramètre modèle NAM
+exchange_parameters_NAM_CKBF            = 95 #Paramètre modèle NAM
+exchange_parameters_NAM_GWLFL1          = 96 #Paramètre modèle NAM
+exchange_parameters_NAM_GWLBF0          = 97 #Paramètre modèle NAM
+exchange_parameters_NAM_SSIGMA          = 98 #Paramètre modèle NAM
+
+exchange_parameters_Froude_min_riv      = 101 #Paramètre modèle VHM_UH méthode de Froude
+exchange_parameters_Froude_max_riv      = 102 #Paramètre modèle VHM_UH méthode de Froude
+exchange_parameters_Froude_min_bas      = 103 #Paramètre modèle VHM_UH méthode de Froude
+exchange_parameters_Froude_max_bas      = 104 #Paramètre modèle VHM_UH méthode de Froude
+exchange_parameters_Froude_discharge    = 105 #Paramètre modèle VHM_UH méthode de Froude
+exchange_parameters_Nash_pt             = 106 #Paramètre modèle VHM_UH méthode de Nash (peak time)
+exchange_parameters_Nash_nb             = 107 #Paramètre modèle VHM_UH méthode de Nash (nb reservoirs)
+exchange_parameters_AsymTri_totTime     = 108 #Paramètre modèle VHM_UH méthode de HU triangulaire asymétrique (temps total)
+exchange_parameters_AsymTri_pt          = 109 #Paramètre modèle VHM_UH méthode de HU triangulaire asymétrique (peak time)
+
+exchange_parameters_Dist_RS_Hs          = 110 #Paramètre modèle distribué Réservoir de stockage
+exchange_parameters_Dist_RS_TS          = 111 #Paramètre modèle distribué Réservoir de stockage
+exchange_parameters_Dist_Soil_Umax      = 112 #Paramètre modèle distribué Soil
+exchange_parameters_Dist_Soil_TSPAN     = 113 #Paramètre modèle distribué Soil
+exchange_parameters_Dist_Horton_F0      = 114 #Paramètre modèle distribué Horton
+exchange_parameters_Dist_Horton_FC      = 115 #Paramètre modèle distribué Horton
+exchange_parameters_Dist_Horton_K       = 116 #Paramètre modèle distribué Horton
+exchange_parameters_Dist_kif            = 117 #Paramètre modèle distribué pour réservoir linéaire couche épidermique (if)
+exchange_parameters_Dist_qlif           = 118 #Paramètre modèle distribué pour réservoir linéaire couche épidermique (if)
 
 
 # Constants representing the exchanges - Python
-exchange_parameters_py_timeDelay    = -11
+exchange_parameters_py_timeDelay        = -11
+
+# All the keys of the param dictionary
+class Type_Keys(Enum):
+    """
+    Enum to define the type of a parameter
+
+    Strings are also used by Fortran Code -- modify with care
+    """
+    Name = 'Integer_or_Float'
+    File = 'Integer'
+    Group = 'Logical'
+    Key = 'Float'
+    Unit = 'File'
+    Conv_factor = 'Convertion Factor'
+    Range = 'Range'
 
 
 # %% All model dictionnaries
@@ -246,8 +306,272 @@ UHDIST_LINBF["Parameters"][exchange_parameters_Froude_discharge]["Group"] = "Fro
 UHDIST_LINBF["Parameters"][exchange_parameters_Froude_discharge]["Key"] = "Discharge"
 UHDIST_LINBF["Parameters"][exchange_parameters_Froude_discharge]["Unit"] = "[m^3/s]"
 
+HBV = {}
+HBV["Nb"] = 10
+HBV["Parameters"] = {}
+HBV["Parameters"][exchange_parameters_HBV_FC] = {}
+HBV["Parameters"][exchange_parameters_HBV_FC]["Name"] = "Fc"
+HBV["Parameters"][exchange_parameters_HBV_FC]["File"] = "simul_soil.param"
+HBV["Parameters"][exchange_parameters_HBV_FC]["Group"] = "Parameters"
+HBV["Parameters"][exchange_parameters_HBV_FC]["Key"] = "Fc"
+HBV["Parameters"][exchange_parameters_HBV_FC]["Unit"] = "[mm]"
+HBV["Parameters"][exchange_parameters_HBV_FC]["Range"] = (50.0, 650.0)
+HBV["Parameters"][exchange_parameters_HBV_beta] = {}
+HBV["Parameters"][exchange_parameters_HBV_beta]["Name"] = "Beta"
+HBV["Parameters"][exchange_parameters_HBV_beta]["File"] = "simul_soil.param"
+HBV["Parameters"][exchange_parameters_HBV_beta]["Group"] = "Parameters"
+HBV["Parameters"][exchange_parameters_HBV_beta]["Key"] = "Beta"
+HBV["Parameters"][exchange_parameters_HBV_beta]["Unit"] = "[-]"
+HBV["Parameters"][exchange_parameters_HBV_beta]["Range"] = (1.0, 5.0)
+HBV["Parameters"][exchange_parameters_HBV_PWP] = {}
+HBV["Parameters"][exchange_parameters_HBV_PWP]["Name"] = "PWP"
+HBV["Parameters"][exchange_parameters_HBV_PWP]["File"] = "simul_soil.param"
+HBV["Parameters"][exchange_parameters_HBV_PWP]["Group"] = "Parameters"
+HBV["Parameters"][exchange_parameters_HBV_PWP]["Key"] = "PWP"
+HBV["Parameters"][exchange_parameters_HBV_PWP]["Unit"] = "[-]"
+HBV["Parameters"][exchange_parameters_HBV_PWP]["Range"] = (0.03, 1.0)
+HBV["Parameters"][exchange_parameters_HBV_SUmax] = {}
+HBV["Parameters"][exchange_parameters_HBV_SUmax]["Name"] = "Su_max"
+HBV["Parameters"][exchange_parameters_HBV_SUmax]["File"] = "simul_UZ.param"
+HBV["Parameters"][exchange_parameters_HBV_SUmax]["Group"] = "Parameters"
+HBV["Parameters"][exchange_parameters_HBV_SUmax]["Key"] = "Su max"
+HBV["Parameters"][exchange_parameters_HBV_SUmax]["Unit"] = "[mm]"
+HBV["Parameters"][exchange_parameters_HBV_SUmax]["Range"] = (0.0, 100.0)
+HBV["Parameters"][exchange_parameters_HBV_kr] = {}
+HBV["Parameters"][exchange_parameters_HBV_kr]["Name"] = "K_r"
+HBV["Parameters"][exchange_parameters_HBV_kr]["File"] = "simul_UZ.param"
+HBV["Parameters"][exchange_parameters_HBV_kr]["Group"] = "Parameters"
+HBV["Parameters"][exchange_parameters_HBV_kr]["Key"] = "Kr"
+HBV["Parameters"][exchange_parameters_HBV_kr]["Unit"] = "[1/h]"
+HBV["Parameters"][exchange_parameters_HBV_kr]["Range"] = (0.05/24.0, 0.5/24.0)
+HBV["Parameters"][exchange_parameters_HBV_kif] = {}
+HBV["Parameters"][exchange_parameters_HBV_kif]["Name"] = "K_if"
+HBV["Parameters"][exchange_parameters_HBV_kif]["File"] = "simul_UZ.param"
+HBV["Parameters"][exchange_parameters_HBV_kif]["Group"] = "Parameters"
+HBV["Parameters"][exchange_parameters_HBV_kif]["Key"] = "Kif"
+HBV["Parameters"][exchange_parameters_HBV_kif]["Unit"] = "[1/h]"
+HBV["Parameters"][exchange_parameters_HBV_kif]["Range"] = (0.01/24.0, 0.4/24.0)
+HBV["Parameters"][exchange_parameters_HBV_kperc] = {}
+HBV["Parameters"][exchange_parameters_HBV_kperc]["Name"] = "K_perc"
+HBV["Parameters"][exchange_parameters_HBV_kperc]["File"] = "simul_UZ.param"
+HBV["Parameters"][exchange_parameters_HBV_kperc]["Group"] = "Parameters"
+HBV["Parameters"][exchange_parameters_HBV_kperc]["Key"] = "Kperc"
+HBV["Parameters"][exchange_parameters_HBV_kperc]["Unit"] = "[1/h]"
+HBV["Parameters"][exchange_parameters_HBV_kperc]["Range"] = (0.0, 0.8/24.0)
+HBV["Parameters"][exchange_parameters_HBV_kbf] = {}
+HBV["Parameters"][exchange_parameters_HBV_kbf]["Name"] = "K_bf"
+HBV["Parameters"][exchange_parameters_HBV_kbf]["File"] = "simul_bf.param"
+HBV["Parameters"][exchange_parameters_HBV_kbf]["Group"] = "Parameters"
+HBV["Parameters"][exchange_parameters_HBV_kbf]["Key"] = "Lagtime"
+HBV["Parameters"][exchange_parameters_HBV_kbf]["Unit"] = "[sec]"
+HBV["Parameters"][exchange_parameters_HBV_kbf]["Convertion Factor"] = 1/3600.0    # [sec] -> [h]
+HBV["Parameters"][exchange_parameters_HBV_kbf]["Range"] = (0.0, 0.15/24.0)
+HBV["Parameters"][exchange_parameters_HBV_CFLUX] = {}
+HBV["Parameters"][exchange_parameters_HBV_CFLUX]["Name"] = "CFLUX"
+HBV["Parameters"][exchange_parameters_HBV_CFLUX]["File"] = "simul_soil.param"
+HBV["Parameters"][exchange_parameters_HBV_CFLUX]["Group"] = "Parameters"
+HBV["Parameters"][exchange_parameters_HBV_CFLUX]["Key"] = "CFLUX"
+HBV["Parameters"][exchange_parameters_HBV_CFLUX]["Unit"] = "[mm/h]"
+HBV["Parameters"][exchange_parameters_HBV_alpha] = {}
+HBV["Parameters"][exchange_parameters_HBV_alpha]["Name"] = "Alpha"
+HBV["Parameters"][exchange_parameters_HBV_alpha]["File"] = "simul_UZ.param"
+HBV["Parameters"][exchange_parameters_HBV_alpha]["Group"] = "Parameters"
+HBV["Parameters"][exchange_parameters_HBV_alpha]["Key"] = "Alpha"
+HBV["Parameters"][exchange_parameters_HBV_alpha]["Unit"] = "[-]"
+
+
+SAC_SMA = {}
+SAC_SMA["Nb"] = 16
+SAC_SMA["Parameters"] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_TW] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_TW]["Name"] = "UZ_TW Max"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_TW]["File"] = "simul_UZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_TW]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_TW]["Key"] = "M_UZ_TW"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_TW]["Unit"] = "[mm]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_TW]["Range"] = (10.0, 150.0)
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_FW] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_FW]["Name"] = "UZ_FW Max"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_FW]["File"] = "simul_UZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_FW]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_FW]["Key"] = "M_UZ_FW"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_FW]["Unit"] = "[mm]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_UZ_FW]["Range"] = (5.0, 100.0)
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_TW] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_TW]["Name"] = "LZ_TW Max"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_TW]["File"] = "simul_LZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_TW]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_TW]["Key"] = "M_LZ_TW"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_TW]["Unit"] = "[mm]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_TW]["Range"] = (50.0,400.0)
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FP] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FP]["Name"] = "LZ_FP Max"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FP]["File"] = "simul_LZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FP]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FP]["Key"] = "M_LZ_FP"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FP]["Unit"] = "[mm]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FP]["Range"] = (30.0, 800.0)
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FS] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FS]["Name"] = "LZ_FS Max"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FS]["File"] = "simul_LZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FS]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FS]["Key"] = "M_LZ_FS"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FS]["Unit"] = "[mm]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_M_LZ_FS]["Range"] = (30.0, 800.0)
+SAC_SMA["Parameters"][exchange_parameters_SAC_kif] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_kif]["Name"] = "Kif"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kif]["File"] = "simul_UZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kif]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kif]["Key"] = "K_if"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kif]["Unit"] = "[1/h]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kif]["Range"] = (0.1/24, 0.75/24)
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fp] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fp]["Name"] = "Kbf_fp"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fp]["File"] = "simul_LZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fp]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fp]["Key"] = "K_fp"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fp]["Unit"] = "[1/h]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fp]["Range"] = (0.001/24, 0.03/24)
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fs] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fs]["Name"] = "Kbf_fs"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fs]["File"] = "simul_LZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fs]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fs]["Key"] = "K_fs"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fs]["Unit"] = "[1/h]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_kbf_fs]["Range"] = (0.02/24, 0.3/24)
+SAC_SMA["Parameters"][exchange_parameters_SAC_zperc] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_zperc]["Name"] = "Z_perc"
+SAC_SMA["Parameters"][exchange_parameters_SAC_zperc]["File"] = "simul_UZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_zperc]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_zperc]["Key"] = "Z_perc"
+SAC_SMA["Parameters"][exchange_parameters_SAC_zperc]["Unit"] = "[-]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_zperc]["Range"] = (10.0, 350.0)
+SAC_SMA["Parameters"][exchange_parameters_SAC_rexp] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_rexp]["Name"] = "R_exp"
+SAC_SMA["Parameters"][exchange_parameters_SAC_rexp]["File"] = "simul_UZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_rexp]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_rexp]["Key"] = "R_exp"
+SAC_SMA["Parameters"][exchange_parameters_SAC_rexp]["Unit"] = "[-]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_rexp]["Range"] = (1.0, 4.0)
+SAC_SMA["Parameters"][exchange_parameters_SAC_rserv] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_rserv]["Name"] = "R_serv"
+SAC_SMA["Parameters"][exchange_parameters_SAC_rserv]["File"] = "simul_LZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_rserv]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_rserv]["Key"] = "R_serv"
+SAC_SMA["Parameters"][exchange_parameters_SAC_rserv]["Unit"] = "[-]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_rserv]["Range"] = (0.0, 1.0)
+SAC_SMA["Parameters"][exchange_parameters_SAC_pfree] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_pfree]["Name"] = "P_free"
+SAC_SMA["Parameters"][exchange_parameters_SAC_pfree]["File"] = "simul_LZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_pfree]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_pfree]["Key"] = "Pfree"
+SAC_SMA["Parameters"][exchange_parameters_SAC_pfree]["Unit"] = "[-]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_pfree]["Range"] = (0.0, 0.6)
+SAC_SMA["Parameters"][exchange_parameters_SAC_side] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_side]["Name"] = "Side"
+SAC_SMA["Parameters"][exchange_parameters_SAC_side]["File"] = "simul_out.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_side]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_side]["Key"] = "Side"
+SAC_SMA["Parameters"][exchange_parameters_SAC_side]["Unit"] = "[-]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_side]["Range"] = (0.0, 0.5)
+SAC_SMA["Parameters"][exchange_parameters_SAC_riva] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_riva]["Name"] = "Riva"
+SAC_SMA["Parameters"][exchange_parameters_SAC_riva]["File"] = "simul_out.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_riva]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_riva]["Key"] = "Riva"
+SAC_SMA["Parameters"][exchange_parameters_SAC_riva]["Unit"] = "[-]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_riva]["Range"] = (0.0, 0.2)
+SAC_SMA["Parameters"][exchange_parameters_SAC_adimp] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_adimp]["Name"] = "S Adimp"
+SAC_SMA["Parameters"][exchange_parameters_SAC_adimp]["File"] = "simul_UZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_adimp]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_adimp]["Key"] = "S_adimp"
+SAC_SMA["Parameters"][exchange_parameters_SAC_adimp]["Unit"] = "[-]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_adimp]["Range"] = (0.0, 0.2)
+SAC_SMA["Parameters"][exchange_parameters_SAC_impv] = {}
+SAC_SMA["Parameters"][exchange_parameters_SAC_impv]["Name"] = "S Imperv"
+SAC_SMA["Parameters"][exchange_parameters_SAC_impv]["File"] = "simul_UZ.param"
+SAC_SMA["Parameters"][exchange_parameters_SAC_impv]["Group"] = "Parameters"
+SAC_SMA["Parameters"][exchange_parameters_SAC_impv]["Key"] = "S_imperv"
+SAC_SMA["Parameters"][exchange_parameters_SAC_impv]["Unit"] = "[-]"
+SAC_SMA["Parameters"][exchange_parameters_SAC_impv]["Range"] = (0.0, 0.05)
 
 
+NAM = {}
+NAM["Nb"] = 10
+NAM["Parameters"] = {}
+NAM["Parameters"][exchange_parameters_NAM_UMAX] = {}
+NAM["Parameters"][exchange_parameters_NAM_UMAX]["Name"] = "U_max"
+NAM["Parameters"][exchange_parameters_NAM_UMAX]["File"] = "simul_SS.param"
+NAM["Parameters"][exchange_parameters_NAM_UMAX]["Group"] = "Parameters"
+NAM["Parameters"][exchange_parameters_NAM_UMAX]["Key"] = "Umax"
+NAM["Parameters"][exchange_parameters_NAM_UMAX]["Unit"] = "[mm]"
+NAM["Parameters"][exchange_parameters_NAM_UMAX]["Range"] = (10.0, 20.0)
+NAM["Parameters"][exchange_parameters_NAM_TOF] = {}
+NAM["Parameters"][exchange_parameters_NAM_TOF]["Name"] = "TOF"
+NAM["Parameters"][exchange_parameters_NAM_TOF]["File"] = "simul_SS.param"
+NAM["Parameters"][exchange_parameters_NAM_TOF]["Group"] = "Parameters"
+NAM["Parameters"][exchange_parameters_NAM_TOF]["Key"] = "TOF"
+NAM["Parameters"][exchange_parameters_NAM_TOF]["Unit"] = "[-]"
+NAM["Parameters"][exchange_parameters_NAM_TOF]["Range"] = (0.0, 0.99)
+NAM["Parameters"][exchange_parameters_NAM_TIF] = {}
+NAM["Parameters"][exchange_parameters_NAM_TIF]["Name"] = "TIF"
+NAM["Parameters"][exchange_parameters_NAM_TIF]["File"] = "simul_SS.param"
+NAM["Parameters"][exchange_parameters_NAM_TIF]["Group"] = "Parameters"
+NAM["Parameters"][exchange_parameters_NAM_TIF]["Key"] = "TIF"
+NAM["Parameters"][exchange_parameters_NAM_TIF]["Unit"] = "[-]"
+NAM["Parameters"][exchange_parameters_NAM_TIF]["Range"] = (0.0, 0.99)
+NAM["Parameters"][exchange_parameters_NAM_CQOF] = {}
+NAM["Parameters"][exchange_parameters_NAM_CQOF]["Name"] = "C_qof"
+NAM["Parameters"][exchange_parameters_NAM_CQOF]["File"] = "simul_SS.param"
+NAM["Parameters"][exchange_parameters_NAM_CQOF]["Group"] = "Parameters"
+NAM["Parameters"][exchange_parameters_NAM_CQOF]["Key"] = "c_qof"
+NAM["Parameters"][exchange_parameters_NAM_CQOF]["Unit"] = "[-]"
+NAM["Parameters"][exchange_parameters_NAM_CQOF]["Range"] = (0.1, 1.0)
+NAM["Parameters"][exchange_parameters_NAM_CKIF] = {}
+NAM["Parameters"][exchange_parameters_NAM_CKIF]["Name"] = "C_kif"
+NAM["Parameters"][exchange_parameters_NAM_CKIF]["File"] = "simul_SS.param"
+NAM["Parameters"][exchange_parameters_NAM_CKIF]["Group"] = "Parameters"
+NAM["Parameters"][exchange_parameters_NAM_CKIF]["Key"] = "c_kif"
+NAM["Parameters"][exchange_parameters_NAM_CKIF]["Unit"] = "[h]"
+NAM["Parameters"][exchange_parameters_NAM_CKIF]["Range"] = (200.0, 1_000.0)
+NAM["Parameters"][exchange_parameters_NAM_LMAX] = {}
+NAM["Parameters"][exchange_parameters_NAM_LMAX]["Name"] = "L_max"
+NAM["Parameters"][exchange_parameters_NAM_LMAX]["File"] = "simul_RZ.param"
+NAM["Parameters"][exchange_parameters_NAM_LMAX]["Group"] = "Parameters"
+NAM["Parameters"][exchange_parameters_NAM_LMAX]["Key"] = "L_max"
+NAM["Parameters"][exchange_parameters_NAM_LMAX]["Unit"] = "[mm]"
+NAM["Parameters"][exchange_parameters_NAM_LMAX]["Range"] = (100.0, 300.0)
+NAM["Parameters"][exchange_parameters_NAM_TG] = {}
+NAM["Parameters"][exchange_parameters_NAM_TG]["Name"] = "TG"
+NAM["Parameters"][exchange_parameters_NAM_TG]["File"] = "simul_RZ.param"
+NAM["Parameters"][exchange_parameters_NAM_TG]["Group"] = "Parameters"
+NAM["Parameters"][exchange_parameters_NAM_TG]["Key"] = "TG"
+NAM["Parameters"][exchange_parameters_NAM_TG]["Unit"] = "[-]"
+NAM["Parameters"][exchange_parameters_NAM_TG]["Range"] = (0.0 ,0.99)
+NAM["Parameters"][exchange_parameters_NAM_CK12] = {}
+NAM["Parameters"][exchange_parameters_NAM_CK12]["Name"] = "C_k 12"
+NAM["Parameters"][exchange_parameters_NAM_CK12]["File"] = ["simul_OF.param", "simul_IF.param"]
+NAM["Parameters"][exchange_parameters_NAM_CK12]["Group"] = ["Time Parameters", "NAM parameters"]
+NAM["Parameters"][exchange_parameters_NAM_CK12]["Key"] = ["Lagtime", "Lagtime"]
+NAM["Parameters"][exchange_parameters_NAM_CK12]["Unit"] = "[h]"
+NAM["Parameters"][exchange_parameters_NAM_CK12]["Range"] = (10.0, 50.0)
+NAM["Parameters"][exchange_parameters_NAM_CAREA] = {}
+NAM["Parameters"][exchange_parameters_NAM_CAREA]["Name"] = "C_area"
+NAM["Parameters"][exchange_parameters_NAM_CAREA]["File"] = "simul_RZ.param"
+NAM["Parameters"][exchange_parameters_NAM_CAREA]["Group"] = "Parameters"
+NAM["Parameters"][exchange_parameters_NAM_CAREA]["Key"] = "C_area"
+NAM["Parameters"][exchange_parameters_NAM_CAREA]["Unit"] = "[-]"
+NAM["Parameters"][exchange_parameters_NAM_CAREA]["Range"] = (0.5, 2.0)
+NAM["Parameters"][exchange_parameters_NAM_CKBF] = {}
+NAM["Parameters"][exchange_parameters_NAM_CKBF]["Name"] = "C_kbf"
+NAM["Parameters"][exchange_parameters_NAM_CKBF]["File"] = "simul_BF.param"
+NAM["Parameters"][exchange_parameters_NAM_CKBF]["Group"] = "Time Parameters"
+NAM["Parameters"][exchange_parameters_NAM_CKBF]["Key"] = "Lagtime"
+NAM["Parameters"][exchange_parameters_NAM_CKBF]["Unit"] = "[sec]"
+NAM["Parameters"][exchange_parameters_NAM_CKBF]["Convertion Factor"] = 1/3600.0    # [sec] -> [h]
+NAM["Parameters"][exchange_parameters_NAM_CKBF]["Range"] = (1_000.0,4_000.0)
+
 
 # General model dictionnary 
 modelParamsDict = {}
@@ -255,7 +579,9 @@ modelParamsDict[cst.tom_VHM] = VHM
 modelParamsDict[cst.tom_GR4] = GR4
 modelParamsDict[cst.tom_UH] = UH
 modelParamsDict[cst.tom_2layers_linIF]= UHDIST_LINBF
-
+modelParamsDict[cst.tom_HBV]= HBV
+modelParamsDict[cst.tom_SAC_SMA]= SAC_SMA
+modelParamsDict[cst.tom_NAM]= NAM
 
 # %% Python-Fortran exchange constants
 

wolfhece/hydrology/plot_hydrology.py

@@ -17,9 +17,9 @@ import math
 import datetime
 import sys
 import logging
-from numpy.core.arrayprint import set_string_function
+# from numpy.core.arrayprint import set_string_function
 
-from numpy.core.defchararray import index
+# from numpy.core.defchararray import index
 
 from ..PyTranslate import _
 
@@ -115,9 +115,9 @@ def compare_plot(nbElements, writeDir, x, y, x_title, y_titles, graph_title='',
 # If y is an array : each element is by column [][here]
 # elif y is a list : each element is located [here][]
 # TO DO : Maybe change this rationale for y -> Too complicated
-def plot_hydro(nbElements:int, y, rain=[], x_title="Dates", y_titles=_("Discharge [m³/s]"), time=None, beginDate:datetime.datetime=None, endDate:datetime.datetime=None, dt:float=None, \
+def plot_hydro(nbElements:int, y, rain=None, x_title="Dates", y_titles=_("Discharge [m³/s]"), time=None, beginDate:datetime.datetime=None, endDate:datetime.datetime=None, dt:float=None, \
                 graph_title:str=None, y_labels:str=None, rangeData:list[datetime.datetime] = [], myColors:list=None, typeOfTraits:list=None, \
-                measures=[], beginDateMeasure=None, endDateMeasure=None, dtMeasure=None, surfaceMeasure=-1.0, addMeasfInTab:bool=False, \
+                measures=None, beginDateMeasure=None, endDateMeasure=None, dtMeasure=None, surfaceMeasure=-1.0, addMeasfInTab:bool=False, \
                 upperPlot:bool=False, nbAddPlot:int=1, z=[], y_labelAddPlot=[], factor_RH:float=1.5, y_rain_range=[], y_data_range=[], figSize = [10.4,6.25],\
                 writeFile:str = '', deltaMajorTicks=-1, deltaMinorTicks=-1, \
                 y_envelop=[], envelopID=0, textInGraph={}, addTable=False, allSurfaces=[], figure=None):
@@ -137,7 +137,7 @@ def plot_hydro(nbElements:int, y, rain=[], x_title="Dates", y_titles=_("Discharg
             print("ERROR: the number of element and the dimension of 'y' does not coincide")
             sys.exit()
     elif(type(y)==list):
-        if(nbElements!=np.shape(y)[0]):
+        if nbElements!=len(y):
             print("ERROR: the number of element and the dimension of 'y' does not coincide")
             sys.exit()
 
@@ -200,7 +200,7 @@ def plot_hydro(nbElements:int, y, rain=[], x_title="Dates", y_titles=_("Discharg
             typeOfTraits.append('-')
 
 
-    if(measures!=[]):
+    if(measures is not None):
         time_delta_measure = datetime.timedelta(seconds=dtMeasure)
 
     if(factor_RH!=1.5 and y_rain_range!=[]):
@@ -227,7 +227,7 @@ def plot_hydro(nbElements:int, y, rain=[], x_title="Dates", y_titles=_("Discharg
             x_date.append(drange(beginDate[i], endDate[i]+time_delta[i], time_delta[i]))
 
 
-    if(measures!=[]):
+    if(measures is not None):
         x_date_measure = drange(beginDateMeasure, endDateMeasure+time_delta_measure, time_delta_measure)
 
     if figure is None:
@@ -401,7 +401,7 @@ def plot_hydro(nbElements:int, y, rain=[], x_title="Dates", y_titles=_("Discharg
 
 
     # Plot measures
-    if(measures!=[]):
+    if(measures is not None):
         y1 = measures
         x_date_measure = check_drange_bug(x_date_measure,y1)
         if(np.nanmax(y1)>max_):
@@ -467,7 +467,7 @@ def plot_hydro(nbElements:int, y, rain=[], x_title="Dates", y_titles=_("Discharg
 
 
     # b) Hyeto
-    if(rain!=[]):
+    if(rain is not None):
         y2 = rain[:] # CAUTION only if the rain is 1 element greater than hydro
         ax2=ax1.twinx()
         ax2.set_ylabel(_('Precipitations [mm/h]'),color='b')
@@ -494,7 +494,7 @@ def plot_hydro(nbElements:int, y, rain=[], x_title="Dates", y_titles=_("Discharg
                 summaryTab[i][-1] = "%.3f"%(summaryTab[i][-1])
                 summaryTab[i][-2] = "%.3f"%(summaryTab[i][-2])
                 summaryTab[i][-3] = "%.3f"%(summaryTab[i][-3])
-        if(measures!=[] and allSurfaces!=[] and surfaceMeasure>0.0 and addMeasfInTab):
+        if(measures is not None and allSurfaces!=[] and surfaceMeasure>0.0 and addMeasfInTab):
             summaryTab[-1].append(np.sum(y2)*dt_Gen/3600.0)
             summaryTab[-1][-2] = summaryTab[-1][-2]*10**(-3)/surfaceMeasure
             tmpRatio = summaryTab[-1][-2]/summaryTab[-1][-1]
@@ -506,11 +506,18 @@ def plot_hydro(nbElements:int, y, rain=[], x_title="Dates", y_titles=_("Discharg
             summaryTab[-1][-1] = "%.3f"%(summaryTab[-1][-1])
             summaryTab[-1][-2] = "%.3f"%(summaryTab[-1][-2])
             summaryTab[-1][-3] = "%.3f"%(summaryTab[-1][-3])
-        elif(measures!=[] and allSurfaces!=[] and addMeasfInTab):
+        elif(measures is not None and allSurfaces!=[] and addMeasfInTab):
             summaryTab[-1].append("/")
             summaryTab[-1][-2] = "/"
             summaryTab[-1].append("/")
-
+    
+    
+    
+    if(deltaMajorTicks>0):
+        etimateNbTicks = (rangeData[1]-rangeData[0]).total_seconds()/deltaMajorTicks
+        if(etimateNbTicks>10_000):
+                logging.warning("WARNING: Too many ticks to plot! The major ticks will be removed.")
+                deltaMajorTicks = -1
 
     if(deltaMajorTicks>0):
         majorTicks = HourLocator(interval=math.floor(deltaMajorTicks/3600))
@@ -555,9 +562,15 @@ def plot_hydro(nbElements:int, y, rain=[], x_title="Dates", y_titles=_("Discharg
                 ax3[i].set_ylabel('Evapotranpiration [mm/h]',color='orange')
             else:
                 ax3[i].set_ylabel(y_labelAddPlot[i],color='orange')
-            xdatePlotGen = check_drange_bug(xdatePlotGen,y1)
-            ax3[i].plot_date(xdatePlotGen,y1, '-', color='orange')
-            ax3[i].set_xlim(rangeData[0],rangeData[1]-time_deltaGen)
+            if xdatePlotGen is None:
+                xdatePlot = x_date[i]
+                xdatePlot = check_drange_bug(xdatePlot,y1)
+                ax3[i].plot_date(xdatePlot,y1, '-', color='orange')
+                ax3[i].set_xlim(rangeData[0],rangeData[1]-time_delta[i])
+            else:
+                xdatePlotGen = check_drange_bug(xdatePlotGen,y1)
+                ax3[i].plot_date(xdatePlotGen,y1, '-', color='orange')
+                ax3[i].set_xlim(rangeData[0],rangeData[1]-time_deltaGen)
             if(deltaMajorTicks>0):
                 majorTicks = HourLocator(interval=math.floor(deltaMajorTicks/3600))
                 ax3[i].xaxis.set_major_locator(majorTicks)
@@ -579,21 +592,24 @@ def plot_hydro(nbElements:int, y, rain=[], x_title="Dates", y_titles=_("Discharg
     if(addTable):
         ax4 = fig.add_subplot(gs[-3:,1:5])
         columnLabels = ["Q peak [m³/s]", "t peak"+x_title.replace("Dates","")]
-        if(len(title)>1) and measures!=[]:
+        if(len(title)>1) and measures is not None:
             if(addMeasfInTab):
                 rowLabels = title[:]
             else:
                 rowLabels = title[:-1]
-        elif len(title)>0 and measures==[]:
+        elif len(title)>0 and measures is None:
             rowLabels = title[:]
         else:
             rowLabels = ["Hydrograph 1"]
 
-        if(rain!=[]):
+        if(rain is not None):
             if(allSurfaces!=[]):
                 columnLabels.append("Q cumul [mm]")
                 columnLabels.append("P cumul [mm]")
                 columnLabels.append("Ratio [-]")
+        else:
+            if(allSurfaces!=[]):
+                columnLabels.append("Q cumul [mm]")
 
         ax4.axis('tight')
         ax4.axis('off')