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

wolfhece/PyParams.py

@@ -1973,10 +1973,14 @@ class Wolf_Param(wx.Frame):
         elif not self.is_in_active(group, name) and self.is_in_default(group, name):
             # le paramètre est dans les paramètres par défaut mais pas dans les paramètres actifs --> on l'ajoute
             default_value = self.myparams_default[group][name]
+            if key_Param.ADDED_JSON in default_value.keys():
+                json = default_value[key_Param.ADDED_JSON]
+            else:
+                json = None
             self.add_param(group, name, value,
                            default_value[key_Param.TYPE],
                            comment=default_value[key_Param.COMMENT],
-                           jsonstr=default_value[key_Param.ADDED_JSON],
+                           jsonstr=json,
                            whichdict='Active')
         elif self.is_in_active(group, name):
             param = self.myparams[group][name]

wolfhece/PyVertexvectors.py

@@ -7883,22 +7883,67 @@ class Zones(wx.Frame, Element_To_Draw):
 
         sz = []
 
+        # Getting s values and Z values from the xls grid
+        # s in column 4 and z in column 2
+        # The first row is the header
         i = 0
         while self.xls.GetCellValue(i,4) != '':
-            sz.append((float(self.xls.GetCellValue(i,4)), float(self.xls.GetCellValue(i,2))))
-            i += 1
+                s = self.xls.GetCellValue(i,4)
+                z = self.xls.GetCellValue(i,2)
+                try:
+                    s = float(s)
+                except:
+                    logging.error(_('Error during update from sz support - check your s data and types (only float)'))
+                    return
+
+                try:
+                    if z == '':
+                        logging.warning(_('No z value -- setting to 0.0'))
+                        z = 0.0
+                    else:
+                        z = float(z)
+                except:
+                    logging.error(_('Error during update from sz support - check your z data and types (only float)'))
+                    return
+
+                sz.append((s, z))
+                i += 1
+
+        if len(sz) == 0:
+            logging.warning(_('No data to update -- Please set s in column "s curvi" (5th) and z in column Z (3th)'))
+            return
 
         logging.info(f'Number of points: {len(sz)}')
 
         vec_sz = np.array(sz)
 
-        self.update_from_sz_support(vec=self.active_vector, sz=vec_sz)
+        memory_xyz = []
+        i = 0
+        while self.xls.GetCellValue(i,0) != '':
+            memory_xyz.append((float(self.xls.GetCellValue(i,0)), float(self.xls.GetCellValue(i,1)), float(self.xls.GetCellValue(i,2))))
+            i += 1
 
-        # update of the xls grid
-        for k in range(self.active_vector.nbvertices ):
-            self.xls.SetCellValue(k,0,str(self.active_vector.myvertices[k].x))
-            self.xls.SetCellValue(k,1,str(self.active_vector.myvertices[k].y))
+        try:
+            self.update_from_sz_support(vec=self.active_vector, sz=vec_sz)
+
+            # update of the xls grid
+            for k in range(self.active_vector.nbvertices ):
+                self.xls.SetCellValue(k,0,str(self.active_vector.myvertices[k].x))
+                self.xls.SetCellValue(k,1,str(self.active_vector.myvertices[k].y))
+        except:
+            logging.error(_('Error during update from sz support - check your data'))
+            logging.info(_('Resetting the active vector to its original state'))
+
+            self.active_vector.myvertices = []
+            for cur in memory_xyz:
+                self.active_vector.add_vertex(wolfvertex(cur[0], cur[1], cur[2]))
+            self.active_vector._reset_listogl()
+            self.active_vector.update_lengths()
+            self.active_vector.find_minmax(True)
 
+            for k in range(self.active_vector.nbvertices ):
+                self.xls.SetCellValue(k,0,str(self.active_vector.myvertices[k].x))
+                self.xls.SetCellValue(k,1,str(self.active_vector.myvertices[k].y))
 
     def update_from_sz_direction(self, xy1:np.ndarray, xy2:np.ndarray, sz:np.ndarray):
         """ Update the active vector from the sz values in the xls grid """

wolfhece/apps/version.py

@@ -5,7 +5,7 @@ class WolfVersion():
 
         self.major = 2
         self.minor = 1
-        self.patch = 128
+        self.patch = 129
 
     def __str__(self):
 

wolfhece/hydrology/Catchment.py

@@ -67,7 +67,8 @@ class Catchment:
     iP_Cloud:cloud_vertices                                                 # cloud of points containing the given coordinates (given in param files) of all subbasin outlets
 
     catchmentDict:dict[Union[str, int], Union[SubBasin, RetentionBasin]]    # dictionnary containing all the elements of the catchment
-    subBasinDict:dict[int, SubBasin]                                        # dictionnary containing all the subbasins
+    subBasinDict:dict[int, SubBasin]                                        # dictionnary containing all the subbasins with the convention dict{ID Interior Point : SubBasin object}
+    retentionBasinDict:dict[str, RetentionBasin]                            # dictionnary containing all the anthropogenic modules
 
     def __init__(self, _name, _workingDir, _plotAllSub, _plotNothing, _initWithResults=True, _catchmentFileName="", _rbFileName="", _tz=0, version=cst.VERSION_WOLFHYDRO):
         "This is the constructor of the class Catchment in which all the caractertics and the network of sub-basins will be created"
@@ -1390,6 +1391,75 @@ class Catchment:
         writer.close()
 
 
+
+    def save_hydro_for_2D(self, fileName:str="Hydros_2_simul2D.txt", directory:str="", format:str='%1.5e'):
+        """
+        Procedure that saves the data in an text file that can be read and used in a 2D model.
+
+        Args:
+            fileName (str, optional): The name of the file to save the data to. Defaults to "Hydros_2_simul2D.txt".
+            directory (str, optional): The directory to save the file in. Defaults to an empty string.
+
+        Returns:
+            None
+        """
+        # Writes subbasins' hydrographs
+        if(directory==""):
+            directory = join(self.workingDir,"PostProcess")
+
+        cur_file = join(directory,fileName)
+        time = np.reshape(self.time - self.time[0],(len(self.time),1))
+        # Extract the data for the hydrological and anthropogenic modules
+        data_subs = [cur_sub.outFlow for cur_sub in sorted(self.subBasinDict.values(), key=lambda sub: sub.iDSorted)]
+        data_anth = [cur_anth.get_outFlow(whichOutFlow=name) for cur_anth in self.retentionBasinDict.values() for name in cur_anth.get_outFlow_names()]
+        # Extract the column names according to their sorted subbasin indices
+        col_time = ["Time [s]"]
+        col_subs = [cur_sub.name for cur_sub in sorted(self.subBasinDict.values(), key=lambda sub: sub.iDSorted)]
+        col_anth = [" : ".join([cur_anth.name, name]) 
+                    for cur_anth in self.retentionBasinDict.values() 
+                    for name in cur_anth.get_outFlow_names()]
+        
+        
+        all_data = np.concatenate((time, np.array(data_subs).T, np.array(data_anth).T), axis=1)
+        all_columns = "\t".join(col_time+col_subs+col_anth)
+        
+        # Save the data in a text file
+        np.savetxt(cur_file, all_data, delimiter='\t', newline="\n", header=all_columns, fmt=format)
+
+
+    def save_own_hydro_for_2D(self, fileName:str="HydrosSub_2_simul2D.txt", directory:str="", format:str='%1.5e'):
+        """
+        Saves subbasins' hydrographs from their own drained surface only (not taking into account the 
+        surface drained by the inlets or upstream elements) to a text file that can be read and used in a 2D model.
+
+        Args:
+            fileName (str, optional): Name of the output file. Defaults to "HydrosSub_2_simul2D.txt".
+            directory (str, optional): Directory where the file will be saved. Defaults to an empty string.
+            format (str, optional): Format string for the data values. Defaults to '%1.5e'.
+
+        Returns:
+            None
+        """
+        # Writes subbasins' hydrographs
+        if(directory==""):
+            directory = join(self.workingDir,"PostProcess")
+
+        cur_file = join(directory,fileName)
+        time = np.reshape(self.time - self.time[0],(len(self.time),1))
+        # Extract the data for the hydrological and anthropogenic modules
+        data_subs = [cur_sub.get_myHydro(unit="m3/s") for cur_sub in sorted(self.subBasinDict.values(), key=lambda sub: sub.iDSorted)]
+        # Extract the column names according to their sorted subbasin indices
+        col_time = ["Time [s]"]
+        col_subs = [cur_sub.name for cur_sub in sorted(self.subBasinDict.values(), key=lambda sub: sub.iDSorted)]
+        
+        
+        all_data = np.concatenate((time, np.array(data_subs).T), axis=1)
+        all_columns = "\t".join(col_time+col_subs)
+        
+        # Save the data in a text file
+        np.savetxt(cur_file, all_data, delimiter='\t', newline="\n", header=all_columns, fmt=format)
+
+
     def save_characteristics(self):
         "Procedure that saves the data in an Excel file."
         # Writes subbasins' main characteristics
@@ -1857,8 +1927,8 @@ class Catchment:
                 # paramsInput.ApplytoMemory(None)
                 paramsInput.SavetoFile(None)
 
-
-    def _correct_Umax_from_old_model(self, adapt_with_rain:bool=True):
+    
+    def _correct_Umax_from_old_model(self, adapt_with_rain:bool=True, k_opt:float=0.0, U_max_opt=0.0):
         fileName = "simul_soil.param"
         which="Umax"
 
@@ -1870,8 +1940,10 @@ class Catchment:
 
             paramsInput = Wolf_Param(to_read=False,toShow=False)
             paramsInput.ReadFile(fileToModif)
-
-            if adapt_with_rain:
+            
+            if U_max_opt>0.0:
+                maxRain = U_max_opt
+            elif adapt_with_rain:
                 myInterval = paramsInput.get_param("Distributed production model parameters", "Time span soil", default_value=0.0)
                 if myInterval==0.0:
                     nbIntervals = len(myBasin.myRain)-1
@@ -1885,10 +1957,13 @@ class Catchment:
                 if maxRain==0.0:
                     logging.warning("The Umax is not adapted with the rain and its value is 0.0. It might be better to put 'adapt_with_rain' to True.")
 
-            k = paramsInput.get_param("Horton parameters", "k", default_value=0.0)
-            if k==0.0:
-                continue
-
+            if k_opt==0.0:
+                k = paramsInput.get_param("Horton parameters", "k", default_value=0.0)
+                if k==0.0:
+                    continue
+            else:
+                k = k_opt
+            
             U_max = maxRain/k
 
             paramsInput.change_param("Distributed production model parameters", which, U_max)
@@ -1899,7 +1974,7 @@ class Catchment:
 
 
 
-    def plot_all_diff_cumulRain_with_lagtime(self, interval, lagTime, selection_by_iD=[], graph_title="", show=True, writeDir="", lawNetRain=0, netRainParams={}):
+    def plot_all_diff_cumulRain_with_lagtime(self, interval=0, lagTime=0, selection_by_iD=[], graph_title="", show=True, writeDir="", lawNetRain=0, netRainParams={}):
         """
 
         """
@@ -2835,6 +2910,32 @@ class Catchment:
         self._set_temporal_parameters(value)
 
 
+    def _set_IC_qif(self, keys:list[str], values:np.ndarray):
+        assert len(keys) == len(values), "The number of keys should be equal to the number of values !"
+        # assert len(keys) == len(self.subBasinDict), "The number of keys should be equal to the number of sub-basins !"
+        # assert len(values) == len(self.subBasinDict), "The number of values should be equal to the number of sub-basins !"
+        fileName = "simul_if.param"
+        group = "Initial conditions"
+        key = "Outflow"
+
+        for iBasin in range(1,len(self.subBasinDict)+1):
+            if self.subBasinDict[iBasin].name in keys:
+                index = np.where(np.array(keys) == self.subBasinDict[iBasin].name)[0][0]
+            else:
+                logging.warning(f"The sub-basin {self.subBasinDict[iBasin].name} is not in the keys list !")
+                continue
+            myBasin = self.subBasinDict[iBasin]
+            dirID = myBasin.iDSorted
+
+            fileToModif = os.path.join(self.workingDir, "Subbasin_" + str(dirID), fileName)
+
+            paramsInput = Wolf_Param(to_read=False,toShow=False)
+            paramsInput.ReadFile(fileToModif)
+            paramsInput.change_param(group, key, values[index])
+            paramsInput.SavetoFile(None)
+            paramsInput.Reload(None)
+        
+
     def make_nd_array(self, c_pointer, shape, dtype=np.float64, order='C', own_data=True,readonly=False):
         arr_size = np.prod(shape[:]) * np.dtype(dtype).itemsize
 

wolfhece/hydrology/Comparison.py

@@ -419,10 +419,10 @@ class Comparison:
             tzPlot = plotDict["General Parameters"]["Time Zone Plot"]
             tzDelta = datetime.timedelta(hours=tzPlot)
 
-        if(envelop and not("Ref Name" in plotDict["General Parameters"])):
-            refName = "Catchment 1"
-        else:
-            refName = plotDict["General Parameters"]["Ref Name"]
+        # if(envelop and not("Ref Name" in plotDict["General Parameters"])):
+        #     refName = "Catchment 1"
+        # else:
+        #     refName = plotDict["General Parameters"]["Ref Name"]
 
         if(not("Add Table" in plotDict["General Parameters"])):
             addTable = False
@@ -524,7 +524,7 @@ class Comparison:
             yLabels = []
             if(not("Catchment traits" in plotDict["General Parameters"])):
                 myTraits = []
-            rain = []
+            rain = None
             z = []
             nbAddRain=0
             y_labelAddRain = []
@@ -721,7 +721,7 @@ class Comparison:
                             myTraits.append('-')
 
                         if(sameRain and displayRain):
-                            if(rain==[]):
+                            if(rain is None):
                                 rain = curCatch.subBasinDict[id].rain/curCatch.subBasinDict[id].surfaceDrainedHydro*3.6
                         elif(displayRain):
                             upperPlot = True
@@ -748,7 +748,7 @@ class Comparison:
                             myTraits.append('-')
 
                         if(sameRain and displayRain):
-                            if(rain==[]):
+                            if(rain is None):
                                 rain = curCatch.subBasinDict[id].rain/curCatch.subBasinDict[id].surfaceDrainedHydro*3.6
                         elif(displayRain):
                             upperPlot = True
@@ -801,7 +801,7 @@ class Comparison:
             if("Measures" in plotDict[basinNames[id]]):
                 Measures = plotDict[basinNames[id]]["Measures"]
                 myMeasure = Measures.myHydro
-                yLabels.append(_("Measures"))
+                yLabels.append(_("Measurement"))
                 catchColorsAddData.append('k')
                 myTraits.append('-')
                 if(Measures.surfaceDrainedHydro>0.0):
@@ -904,6 +904,11 @@ class Comparison:
         else:
             dt = plotDict["General Parameters"]["Dt"]
 
+        if(not("Add Table" in plotDict["General Parameters"])):
+            addTable = False
+        else:
+            addTable = plotDict["General Parameters"]["Add Table"]
+
         # if(envelop and not("Ref Name" in plotDict["General Parameters"])):
         #     refName = "Catchment 1"
 
@@ -1029,7 +1034,7 @@ class Comparison:
             if("Measures" in plotDict[RBNames[id]]):
                 Measures = plotDict[RBNames[id]]["Measures"]
                 myMeasure = Measures.myHydro
-                yLabels.append(_("Measures"))
+                yLabels.append(_("Measurement"))
                 catchColorsAddData.append('k')
                 myTraits.append('--')
             else:
@@ -1052,15 +1057,17 @@ class Comparison:
 
 
             # Plot Rains
-            yTitles = "Hauteurs d'eau [m]"
-            writeFileDef = writeFile + "_H_" + graph_title.replace(".","")
+            yTitles = _("Water level [m]")
+            writeFileDef = os.path.join(writeFile, "H_" + graph_title.replace(".",""))
             if(Measures is not None):
                 ph.plot_hydro(nbCatchment+nbAddData, y1,x_title=x_title, y_titles=yTitles, beginDate=beginDateRB+beginDateAddData,endDate=endDateRB+endDateAddData,dt=dt+dtAddData,graph_title=graph_title, \
                             y_labels=yLabels,rangeData=xRange,y_data_range=yRange,myColors=catchColors+catchColorsAddData,typeOfTraits=myTraits,writeFile=writeFileDef,\
-                            measures=myMeasure,beginDateMeasure=Measures.dateBegin+tzDelta, endDateMeasure=Measures.dateEnd+tzDelta,dtMeasure=Measures.deltaT,deltaMajorTicks=86400/2.0,deltaMinorTicks=3600)
+                            measures=myMeasure,beginDateMeasure=Measures.dateBegin+tzDelta, endDateMeasure=Measures.dateEnd+tzDelta,dtMeasure=Measures.deltaT,deltaMajorTicks=86400/2.0,deltaMinorTicks=3600,
+                            addTable=addTable)
             else:
                 ph.plot_hydro(nbCatchment+nbAddData, y1,x_title=x_title, y_titles=yTitles, beginDate=beginDateRB+beginDateAddData,endDate=endDateRB+endDateAddData,dt=dt+dtAddData,graph_title=graph_title, \
-                            y_labels=yLabels,rangeData=xRange,y_data_range=yRange,myColors=catchColors+catchColorsAddData,typeOfTraits=myTraits,writeFile=writeFileDef,deltaMajorTicks=86400/2.0,deltaMinorTicks=3600)
+                            y_labels=yLabels,rangeData=xRange,y_data_range=yRange,myColors=catchColors+catchColorsAddData,typeOfTraits=myTraits,writeFile=writeFileDef,deltaMajorTicks=86400/2.0,deltaMinorTicks=3600,
+                            addTable=addTable)
 
         if(show):
             plt.show()
@@ -1175,7 +1182,7 @@ class Comparison:
             yLabels = []
             if(not("Catchment traits" in plotDict["General Parameters"])):
                 myTraits = []
-            rain = []
+            rain = None
             z = []
             nbAddRain=0
             y_labelAddRain = []
@@ -1308,7 +1315,7 @@ class Comparison:
             if("Measures" in plotDict[RBNames[id]]):
                 Measures = plotDict[RBNames[id]]["Measures"]
                 myMeasure = Measures.myHydro
-                yLabels.append(_("Measures"))
+                yLabels.append(_("Measurement"))
                 catchColorsAddData.append('k')
                 myTraits.append('-')
                 if(Measures.surfaceDrainedHydro>0.0):
@@ -1387,7 +1394,7 @@ class Comparison:
 
 
 
-    def plot_all_diff_cumulRain_with_lagtime(self, interval, selection_by_iD=[], writeDir=""):
+    def plot_all_diff_cumulRain_with_lagtime(self, interval=0, selection_by_iD=[], writeDir=""):
 
         for idCatch in self.myCatchments:
             curCatch:Catchment = self.myCatchments[idCatch]['Object']
@@ -1529,10 +1536,7 @@ class Comparison:
         self.plotDict[stationKey]["Add Data"]["Dt"] = []
 
         for element in myAddDataObj:
-            if addDataUnits == "mm/h":
-                self.plotDict[stationKey]["Add Data"]["Data"].append(element.myHydro[:])
-            else:
-                self.plotDict[stationKey]["Add Data"]["Data"].append(element.myHydro[:]*element.surfaceDrained/3.6)
+            self.plotDict[stationKey]["Add Data"]["Data"].append(element.get_myHydro(unit=addDataUnits))
             self.plotDict[stationKey]["Add Data"]["Date Begin"].append(element.dateBegin)
             self.plotDict[stationKey]["Add Data"]["Date End"].append(element.dateEnd)
             self.plotDict[stationKey]["Add Data"]["Dt"].append(element.deltaT)
@@ -1579,7 +1583,7 @@ class Comparison:
 
 
     
-    def plot_Nash_and_peak(self, stationKey:list[str, int], measures:list[SubBasin], intervals:list=[]):
+    def plot_Nash_and_peak(self, stationKey:list[str, int], measures:list[SubBasin], intervals:list=[], toShow:bool=True):
         assert len(stationKey) == len(measures)
 
         all_ns = {stationKey[i]: [ self.myCatchments[el]["Object"].get_sub_Nash(measures[i], stationKey[i], intervals) 
@@ -1662,8 +1666,8 @@ class Comparison:
         type_of_data = ["Nash", r"$  \frac{Q^{s}_{max}-Q^{m}_{max}}{Q^{m}_{max}} $ "]
         type_of_data_names = ["Nash", "Exceedance"]
 
-        ph.bar_Nash_n_other(all_data, all_colors, nb_x=len(intervals), nb_data=len(type_of_model), nb_lines=nb_stations, 
-                            y_titles=type_of_data, x_titles=all_names, nameModel=type_of_model, line_names=sorted_keys, toShow=False)
+        # ph.bar_Nash_n_other(all_data, all_colors, nb_x=len(intervals), nb_data=len(type_of_model), nb_lines=nb_stations, 
+        #                     y_titles=type_of_data, x_titles=all_names, nameModel=type_of_model, line_names=sorted_keys, toShow=False)
         
         # =========
         # =========
@@ -1700,5 +1704,5 @@ class Comparison:
                 ph.table_Nash_n_other(cur_data, name_of_data, 
                                     row_names=sorted_keys, column_names=all_names, 
                                     writeFile=file_name, toShow=False)
-
-        plt.show()
+        if toShow:
+            plt.show()