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

wolfhece/hydrology/Catchment.py

@@ -143,7 +143,7 @@ class Catchment:
 
         # Read the input files
         # read the Main File
-        self.paramsInput = Wolf_Param(to_read=False,toShow=False)
+        self.paramsInput = Wolf_Param(to_read=False, toShow=False)
         self.paramsInput.ReadFile(os.path.join(self.workingDir,'Main_model.param'))
         # Get the version of WOLFHydro
         self.change_version(self.paramsInput.get_param("General information", "Version WOLFHydo"))
@@ -343,7 +343,7 @@ class Catchment:
         self._fill_cloud_retentionbasin()
 
     def get_subBasin(self, id_sorted_or_name:int | str) -> SubBasin:
-        """ 
+        """
         This method returns the subbasin object associated with the sorted id or name given in argument.
 
         The sorted id is the one given by the Fortran code.
@@ -620,7 +620,7 @@ class Catchment:
 
     def get_retentionbasin_zones(self)-> Zones:
         """ This method returns a Zones instance of the retention basins. """
-        
+
         zones = Zones()
         for curRB in self.retentionBasinDict.values():
             curRB:RetentionBasin
@@ -1857,7 +1857,7 @@ class Catchment:
                 # paramsInput.ApplytoMemory(None)
                 paramsInput.SavetoFile(None)
 
-    
+
     def _correct_Umax_from_old_model(self, adapt_with_rain:bool=True):
         fileName = "simul_soil.param"
         which="Umax"
@@ -1870,7 +1870,7 @@ class Catchment:
 
             paramsInput = Wolf_Param(to_read=False,toShow=False)
             paramsInput.ReadFile(fileToModif)
-            
+
             if adapt_with_rain:
                 myInterval = paramsInput.get_param("Distributed production model parameters", "Time span soil", default_value=0.0)
                 if myInterval==0.0:
@@ -1888,7 +1888,7 @@ class Catchment:
             k = paramsInput.get_param("Horton parameters", "k", default_value=0.0)
             if k==0.0:
                 continue
-            
+
             U_max = maxRain/k
 
             paramsInput.change_param("Distributed production model parameters", which, U_max)
@@ -1951,7 +1951,7 @@ class Catchment:
             isOk, directory = check_path(directory, self.workingDir)
             if isOk<0:
                 logging.error(_("ERROR : measuring station data path not present! "))
-            fileName = os.path.join(directory, self.paramsInput.get_param("Measuring stations SPW", "Filename")) 
+            fileName = os.path.join(directory, self.paramsInput.get_param("Measuring stations SPW", "Filename"))
 
 
         if os.path.exists(fileName):
@@ -2305,11 +2305,11 @@ class Catchment:
 
 
         return timeDelays
-    
+
 
     def get_timeDelays_inlets(self, ref:str = "") -> dict[str, float]:
-        
-        
+
+
         if(ref==""):
             junctionKey = self.junctionOut
         else:
@@ -2317,7 +2317,7 @@ class Catchment:
             if junctionKey is None:
                 logging.error("ERROR : Wrong reference to extract timeDelay !")
                 return
-        
+
         junctionKey = self.junctionOut
         refObj = self.catchmentDict[junctionKey]
         time_delays_inlets = refObj.get_timeDelays_inlets()
@@ -2535,14 +2535,14 @@ class Catchment:
         if self.charact_watrshd.to_update_times:
             self.charact_watrshd.update_times(self.time_wolf_array)
 
-    
+
     def get_all_x_production(self, selection_by_iD: list = [], to_save:bool=True, to_plot:bool=False) -> dict:
         """
         Retrieves the x production values for all sub-basins or a specific selection of sub-basins.
 
         Args:
-            selection_by_iD (list, optional): A list of sub-basin IDs to retrieve x production values for. 
-                                              If empty, retrieves x production values for all sub-basins. 
+            selection_by_iD (list, optional): A list of sub-basin IDs to retrieve x production values for.
+                                              If empty, retrieves x production values for all sub-basins.
                                               Defaults to [].
 
         Returns:
@@ -2560,23 +2560,23 @@ class Catchment:
                 cur_key = self.get_key_catchmentDict(curID)
                 curBasin: SubBasin = self.catchmentDict[cur_key]
                 all_x[curID] = curBasin.collect_x_from_production()
-        
+
         if to_save:
             rd.write_excel_from_dict(all_x, path=self.workingDir, fileName="PostProcess/all_x.xlsx", time=self.time)
 
         return all_x
-    
 
-    def get_all_fractions(self, plt_dict:dict[str:np.array]={},selection_by_iD: list = [], 
+
+    def get_all_fractions(self, plt_dict:dict[str:np.array]={},selection_by_iD: list = [],
                           to_save:bool=True, to_plot:bool=False,
-                          summary:str=None, summary_interval:list[datetime.datetime]=None, 
+                          summary:str=None, summary_interval:list[datetime.datetime]=None,
                           add_info:dict[dict[str,float]]={}) -> dict:
         """
         Retrieves the physical flux fractions values for all sub-basins or a specific selection of sub-basins.
 
         Args:
-            selection_by_iD (list, optional): A list of sub-basin IDs to retrieve fractions values for. 
-                                              If empty, retrieves fractions values for all sub-basins. 
+            selection_by_iD (list, optional): A list of sub-basin IDs to retrieve fractions values for.
+                                              If empty, retrieves fractions values for all sub-basins.
                                               Defaults to [].
 
         Returns:
@@ -2598,7 +2598,7 @@ class Catchment:
             summary_fractions = {}
             summary_dict = {}
             if selection_by_iD == []:
-                summary_fractions = {curBasin.name: curBasin.get_summary_fractions(summary=summary, interval=summary_interval) 
+                summary_fractions = {curBasin.name: curBasin.get_summary_fractions(summary=summary, interval=summary_interval)
                                      for curBasin in self.subBasinDict.values()}
             else:
                 for curID in selection_by_iD:
@@ -2628,9 +2628,9 @@ class Catchment:
                         else:
                             summary_dict[key_add].append(np.nan)
 
-                            
 
-            # summary_dict = {cur_key: [cur_dict[cur_key] for cur_dict in summary_fractions.values() if cur_key in cur_dict] 
+
+            # summary_dict = {cur_key: [cur_dict[cur_key] for cur_dict in summary_fractions.values() if cur_key in cur_dict]
             #                 for cur_dict in summary_fractions.values() for cur_key in cur_dict}
             # all_fractions["Summary"] = summary_dict
 
@@ -2641,7 +2641,7 @@ class Catchment:
             self.plot_all_fractions(all_fractions)
 
         return all_fractions
-        
+
 
     def plot_all_fractions(self, all_fractions:dict[str:np.array]={}, selection_by_iD:list=[], to_show:bool=False, writeDir:str="", range_data:list[datetime.datetime]=[]):
 
@@ -2655,7 +2655,7 @@ class Catchment:
             for curID in selection_by_iD:
                 cur_key = self.get_key_catchmentDict(curID)
                 curBasin: SubBasin = self.catchmentDict[cur_key]
-                curBasin.plot_all_fractions(to_show=False, writeDir=writeDir, range_data=range_data) 
+                curBasin.plot_all_fractions(to_show=False, writeDir=writeDir, range_data=range_data)
 
         if to_show:
             plt.show()
@@ -2667,8 +2667,8 @@ class Catchment:
         Retrieves the x production values for all sub-basins or a specific selection of sub-basins.
 
         Args:
-            selection_by_iD (list, optional): A list of sub-basin IDs to retrieve x production values for. 
-                                              If empty, retrieves x production values for all sub-basins. 
+            selection_by_iD (list, optional): A list of sub-basin IDs to retrieve x production values for.
+                                              If empty, retrieves x production values for all sub-basins.
                                               Defaults to [].
 
         Returns:
@@ -2691,15 +2691,15 @@ class Catchment:
             rd.write_excel_from_dict(all_iv, path=self.workingDir, fileName="PostProcess/all_iv.xlsx", time=self.time)
 
         return all_iv
-    
-    
+
+
     def activate_all_internal_variables(self, selection_by_iD: list = [])->dict:
         """
         Activates all internal variables for all sub-basins or a specific selection of sub-basins.
 
         Args:
-            selection_by_iD (list, optional): A list of sub-basin IDs to activate internal variables for. 
-                                              If empty, activates internal variables for all sub-basins. 
+            selection_by_iD (list, optional): A list of sub-basin IDs to activate internal variables for.
+                                              If empty, activates internal variables for all sub-basins.
                                               Defaults to [].
 
         Returns:
@@ -2722,8 +2722,8 @@ class Catchment:
         Checks the presence of internal variables for all sub-basins or a specific selection of sub-basins.
 
         Args:
-            selection_by_iD (list, optional): A list of sub-basin IDs to check the presence of internal variables for. 
-                                              If empty, checks the presence of internal variables for all sub-basins. 
+            selection_by_iD (list, optional): A list of sub-basin IDs to check the presence of internal variables for.
+                                              If empty, checks the presence of internal variables for all sub-basins.
                                               Defaults to [].
 
         Returns:
@@ -2743,7 +2743,7 @@ class Catchment:
                 all_x[curID] = curBasin.check_presence_of_iv()
 
         return all_x
-    
+
 
     def get_all_Qtest(self, selection_by_iD: list = [], nb_atttempts:int=-1) :
 
@@ -2755,17 +2755,17 @@ class Catchment:
             #     curBasin: SubBasin = self.catchmentDict[cur_key]
             #     q_test = curBasin.get_all_Qtest(nb_atttempts)
             q_test = [
-                self.catchmentDict[self.get_key_catchmentDict(curID)].get_all_Qtest(nb_atttempts) 
+                self.catchmentDict[self.get_key_catchmentDict(curID)].get_all_Qtest(nb_atttempts)
                 for curID in selection_by_iD ]
 
         return q_test
-    
+
 
     def _get_simulation_intervals(self):
         """
         This procedure is getting the simulation intervals of the current module.
         """
-        
+
         nb_interv = self.paramsInput.get_param("Simulation intervals", "Nb", default_value=0)
         simulation_intervals = []
         for i in range(1, nb_interv+1):
@@ -2776,18 +2776,18 @@ class Catchment:
             simulation_intervals.append((di,df))
 
         return simulation_intervals
-    
+
 
     def _set_simulation_intervals(self, simulation_intervals:list[tuple[datetime.datetime,datetime.datetime]]):
         """
         This procedure is setting the simulation intervals of the current module.
         """
-        
+
         self.paramsInput.change_param("Simulation intervals", "Nb", len(simulation_intervals))
         for i, interval in enumerate(simulation_intervals):
             self.paramsInput.change_param("Simulation intervals", "Date begin "+str(i+1), interval[0].strftime(cst.DATE_FORMAT_HYDRO))
             self.paramsInput.change_param("Simulation intervals", "Date end "+str(i+1), interval[1].strftime(cst.DATE_FORMAT_HYDRO))
-        
+
         self.paramsInput.SavetoFile(None)
         self.paramsInput.Reload(None)
 
@@ -2795,7 +2795,7 @@ class Catchment:
     @property
     def simulation_intervals(self) ->list[tuple[datetime.datetime,datetime.datetime]]:
         return self._get_simulation_intervals()
-    
+
 
     @simulation_intervals.setter
     def simulation_intervals(self, value:list[tuple[datetime.datetime,datetime.datetime]]):
@@ -2806,29 +2806,29 @@ class Catchment:
         """
         This procedure is getting the temporal parameters of the current module.
         """
-        
+
         return (self.dateBegin, self.dateEnd)
-    
-    
+
+
     def _set_temporal_parameters(self, simulation_intervals:tuple[datetime.datetime,datetime.datetime]):
         """
         This procedure is setting the temporal parameters of the current module.
         """
-        
+
         self.dateBegin = simulation_intervals[0]
         self.dateEnd = simulation_intervals[1]
 
         self.paramsInput.change_param("Temporal Parameters", "Start date time", self.dateBegin.strftime(cst.DATE_FORMAT_HYDRO))
         self.paramsInput.change_param("Temporal Parameters", "End date time", self.dateEnd.strftime(cst.DATE_FORMAT_HYDRO))
-        
+
         self.paramsInput.SavetoFile(None)
         self.paramsInput.Reload(None)
 
-    
+
     @property
     def temporal_parameters(self) ->tuple[datetime.datetime, datetime.datetime]:
         return self._get_temporal_parameters()
-    
+
 
     @temporal_parameters.setter
     def temporal_parameters(self, value:tuple[datetime.datetime,datetime.datetime]):