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

wolfhece/hydrology/RetentionBasin.py

@@ -104,8 +104,8 @@ class RetentionBasin():
 
         self.outletObj = None   # object to compute the outlet
 
-        self.zData = []         # height from z-v file stored
-        self.vData = []         # volume from z-v file stored
+        self.zData = None         # height from z-v file stored
+        self.vData = None         # volume from z-v file stored
         self.zvInterpol = None
 
         self.timeDelay = 0.0    # [s]????? -> A vérifier!!!
@@ -663,7 +663,7 @@ class RetentionBasin():
             time_delta = datetime.timedelta(seconds=dt)
             if(rangeData==[]):
                 rangeData = [beginDate,endDate]
-            x_date = drange(beginDate, endDate, time_delta)
+            x_date = drange(beginDate, endDate+time_delta, time_delta)
 
         font11 = FontProperties()
         font11.set_family('serif')
@@ -698,7 +698,8 @@ class RetentionBasin():
             if(axis=="Hours"):
                 ax1.plot(x, y, label = name)
             else:
-                ax1.plot_date(x_date, y, '-', label = name)
+                x_plot = ph.check_drange_bug(x_date, y)
+                ax1.plot_date(x_plot, y, '-', label = name)
         for iInlet in self.directFluxObj :
             y = self.directFluxObj[iInlet].get_outFlow_global(typeOutFlow="Net", whichOutFlow=iInlet)
             name = self.directFluxObj[iInlet].name + " " + iInlet
@@ -708,7 +709,8 @@ class RetentionBasin():
             if(axis=="Hours"):
                 ax1.plot(x, y, '-.', label = name)
             else:
-                ax1.plot_date(x_date, y, '-.', label = name)
+                x_plot = ph.check_drange_bug(x_date, y)
+                ax1.plot_date(x_plot, y, '-.', label = name)
 
         for iOutFlow in self._outFlow:
             y = self.get_outFlow_global(typeOutFlow="Net", whichOutFlow=iOutFlow)
@@ -716,16 +718,18 @@ class RetentionBasin():
             if(axis=="Hours"):
                 ax1.plot(x, y, label = self.name+" "+iOutFlow, color='k')
             else:
-                ax1.plot_date(x_date, y, '-', label = self.name+" "+iOutFlow, color='k')
+                x_plot = ph.check_drange_bug(x_date, y)
+                ax1.plot_date(x_plot, y, '-', label = self.name+" "+iOutFlow, color='k')
 
         if(plotRaw):
-            nameMainOut = list(self.outFlow.items())[0][0]
+            nameMainOut = list(self._outFlow.items())[0][0]
             y = self.get_outFlow_global(typeOutFlow="Raw", whichOutFlow=nameMainOut)
 
             if(axis=="Hours"):
                 ax1.plot(x, y, '--', label = self.name+' Raw', color='k')
             else:
-                ax1.plot(x_date, y, '--', label = self.name+' Raw', color='k')
+                x_plot = ph.check_drange_bug(x_date, y)
+                ax1.plot(x_plot, y, '--', label = self.name+' Raw', color='k')
 
         if(axis=="Hours"):
             ax1.set_xlim(x[0], x[len(x)-1])
@@ -793,7 +797,8 @@ class RetentionBasin():
             else:
                 y = self.hBank*np.ones(len(x))
         else:
-            ax2.plot_date(x_date, y, '-', label = self.name)
+            x_plot = ph.check_drange_bug(x_date, y)
+            ax2.plot_date(x_plot, y, '-', label = self.name)
             if unitReservoir == "[m^3]":
                 y = self.volume*np.ones(len(x_date))
             else:
@@ -807,9 +812,11 @@ class RetentionBasin():
             ax2.grid()
         else:
             if unitReservoir == "[m^3]":
-                ax2.plot_date(x_date, y, '--', label = "Volume max")
+                x_plot = ph.check_drange_bug(x_date, y)
+                ax2.plot_date(x_plot, y, '--', label = "Volume max")
             else:
-                ax2.plot_date(x_date, y, '--', label = "Height max")
+                x_plot = ph.check_drange_bug(x_date, y)
+                ax2.plot_date(x_plot, y, '--', label = "Height max")
             ax2.set_xlim(rangeData[0], rangeData[1])
 
 
@@ -868,7 +875,7 @@ class RetentionBasin():
 
         if(volume==0.0):
             h=0
-        elif(self.zData!=[]):
+        elif(self.zData is not None):
             if(volume>max(self.zvVtoHInterpol.x)):
                 # h = max(self.zvVtoHInterpol.y)
                 slope = (self.zvVtoHInterpol.y[-1]-self.zvVtoHInterpol.y[-2])/(self.zvVtoHInterpol.x[-1]-self.zvVtoHInterpol.x[-2])
@@ -888,7 +895,7 @@ class RetentionBasin():
 
         if(h==0):
             vol = 0
-        elif(self.zData!=[]):
+        elif(self.zData is not None):
             if(h>max(self.zvHtoVInterpol.x)):
                 # h_tmp=max(self.zvHtoVInterpol.x)
                 # vol = self.zvHtoVInterpol(h_tmp)
@@ -1747,7 +1754,7 @@ class RetentionBasin():
         Returns the outFlow in the global time, i.e. the hydrograph to which the timeDelay is applied.
         """
         if self.type == "HelleRB" :
-            if whichOutFlow == self._outFlow.keys[0]:
+            if whichOutFlow == list(self._outFlow.keys())[0]:
                 tD = self.timeDelay
             else:
                 tD = self.downstreamObj[whichOutFlow].timeDelay

wolfhece/hydrology/SubBasin.py

@@ -989,6 +989,95 @@ class SubBasin:
                 print("ERROR: the dates read are not consitent with the dates already recored in this subbasin!")
                 sys.exit()
             return timeArray[:index], outFlow[:index]
+        
+        else:
+            # Valid for any hydro model with an assement module at the end, there is only 1 output to consider.
+
+            print("Reading the 1 outlet file ...")
+            matrixData = []
+
+            # Reading the overland flow file and time
+            if(fileNames is None):
+                subBasinName = os.path.join(workingDir, 'Subbasin_' + str(iDSorted), 'simul_')
+                fileName = subBasinName + "out.txt"
+            else:
+                # The file can only be a string or a list with 1 string
+                if(type(fileNames)==str):
+                    fileName = workingDir + fileNames[0]
+                elif(type(fileNames)==list and len(fileNames)==1):
+                    fileName = workingDir + fileNames
+                else:
+                    print("ERROR: Expecting only 1 file name for UH model!")
+                    sys.exit()
+
+            with open(fileName, newline = '') as fileID:
+                data_reader = csv.reader(fileID, delimiter='\t')
+                list_data = []
+                i=0
+                for raw in data_reader:
+                    if i>1:
+                        list_data.append(raw)
+                    i += 1
+            matrixData = np.array(list_data).astype("float")
+            timeArray = np.zeros(len(matrixData))
+            # Init of the outflow array
+            outFlow = np.zeros((len(matrixData),1),dtype=ct.c_double, order='F')
+
+            # Init the time properties if not already done
+            if self.dateBegin is None or self.dateEnd is None or self.deltaT == 0:
+                self.dateBegin = datetime.datetime(year=int(matrixData[0][2]), month=int(matrixData[0][1]), day=int(matrixData[0][0]), 
+                                                    hour=int(matrixData[0][3]), minute=int(matrixData[0][4]), second=int(matrixData[0][5]),  
+                                                    microsecond=0, tzinfo=datetime.timezone.utc)
+                self.dateEnd = datetime.datetime(year=int(matrixData[-1][2]), month=int(matrixData[-1][1]), day=int(matrixData[-1][0]), 
+                                                    hour=int(matrixData[-1][3]), minute=int(matrixData[-1][4]), second=int(matrixData[-1][5]),  
+                                                    microsecond=0, tzinfo=datetime.timezone.utc)
+                self.deltaT = (datetime.datetime(year=int(matrixData[1][2]), month=int(matrixData[1][1]), day=int(matrixData[1][0]), 
+                                hour=int(matrixData[1][3]), minute=int(matrixData[1][4]), second=int(matrixData[1][5]),  
+                                microsecond=0, tzinfo=datetime.timezone.utc) - self.dateBegin).total_seconds()
+
+            secondsInDay = 24*60*60
+            prevDate = datetime.datetime(year=int(matrixData[0][2]), month=int(matrixData[0][1]), day=int(matrixData[0][0]), hour=int(matrixData[0][3]), minute=int(matrixData[0][4]), second=int(matrixData[0][5]),  microsecond=0, tzinfo=datetime.timezone.utc)
+            prevDate -= tzDelta
+            if(self.dateBegin!=prevDate):
+                print("ERROR: The first date in hydro data does not coincide with the one expected!")
+                print("Date read = ", prevDate)
+                print("Date expected = ", self.dateBegin)
+                sys.exit()
+            timeArray[0] = datetime.datetime.timestamp(prevDate)
+            outFlow[0][0] = matrixData[0][6]
+            
+            for i in range(1,len(matrixData)):
+                currDate = datetime.datetime(year=int(matrixData[i][2]), month=int(matrixData[i][1]), day=int(matrixData[i][0]), 
+                                             hour=int(matrixData[i][3]), minute=int(matrixData[i][4]), second=int(matrixData[i][5]),  
+                                             microsecond=0, tzinfo=datetime.timezone.utc)
+                currDate -= tzDelta
+                prevDate = datetime.datetime(year=int(matrixData[i-1][2]), month=int(matrixData[i-1][1]), day=int(matrixData[i-1][0]), 
+                                             hour=int(matrixData[i-1][3]), minute=int(matrixData[i-1][4]), second=int(matrixData[i-1][5]),  
+                                             microsecond=0, tzinfo=datetime.timezone.utc)
+                prevDate -= tzDelta
+                diffDate = currDate - prevDate
+                diffTimeInSeconds = diffDate.days*secondsInDay + diffDate.seconds
+                timeArray[i] = datetime.datetime.timestamp(currDate)
+
+                outFlow[i][0] = matrixData[i][6]
+
+            if(self.dateEnd!=currDate):
+                print("ERROR: The last date in hydro data does not coincide with the one expected!")
+                print("Date read = ", currDate)
+                print("Date expected = ", self.dateEnd)
+                sys.exit()
+            if(self.deltaT!=diffTimeInSeconds):
+                print("Delta t read = ", diffTimeInSeconds)
+                print("Delta t expected = ", self.deltaT)
+                print("ERROR: The last timestep in hydro data does not coincide with the one expected!")
+                sys.exit()
+            # Save time array if it does not exist yet
+            # Otherwise, check the consistency of the array with the time array of the object
+            if(self.time is None):
+                self.time=timeArray
+            elif((self.time!=timeArray).all()):
+                print("ERROR: the dates read are not consitent with the dates already recored in this subbasin!")
+                sys.exit()
 
         return timeArray, outFlow
 
@@ -1152,7 +1241,8 @@ class SubBasin:
             self._outFlow[nameOutFlow]["Raw"] = self.inletsRaw + tmpHydro
             # Real hydrograph
             self._outFlow[nameOutFlow]["Net"]  = self.inlets + tmpHydro
-        elif(self.model==cst.tom_VHM or self.model==cst.tom_2layers_linIF or self.model==cst.tom_2layers_UH):
+        elif(self.model==cst.tom_VHM or self.model==cst.tom_2layers_linIF or self.model==cst.tom_2layers_UH or 
+             self.model==cst.tom_HBV, self.model==cst.tom_SAC_SMA, self.model==cst.tom_NAM):
             tmpOutFlow = np.sum(self.myHydro,1)*self.surfaceDrained/3.6
 
             # Raw hydrograph
@@ -1459,7 +1549,8 @@ class SubBasin:
         - the raw outlet: in black dashed line
         """
 
-        if(self.model==cst.tom_UH or self.model==cst.tom_2layers_linIF or self.model==cst.tom_2layers_UH or self.model==cst.tom_GR4):
+        if(self.model==cst.tom_UH or self.model==cst.tom_2layers_linIF or self.model==cst.tom_2layers_UH or self.model==cst.tom_GR4 or 
+           self.model==cst.tom_HBV, self.model==cst.tom_SAC_SMA, self.model==cst.tom_NAM):
             # x = self.time/3600.0
             if(axis=="Hours"):
                 x = (self.time[:]-self.time[0])/3600.0
@@ -1663,6 +1754,9 @@ class SubBasin:
         elif(self.model==cst.tom_2layers_linIF or self.model==cst.tom_2layers_UH):
             nbElements = 3
             lastElement = 0
+        else:
+            nbElements = 1
+            lastElement = 0
 
         # Construction of the list of element to plot on the main hydrograph
         myOutFlow = self.outFlow_global
@@ -1675,7 +1769,7 @@ class SubBasin:
                 y[:,i] = self.myHydro[:,i]*self.surfaceDrained/3.6
                 tmpSum += self.myHydro[:,i]*self.surfaceDrained/3.6
             y[:,-1] = tmpSum
-        elif(self.model==cst.tom_GR4):
+        elif(self.model==cst.tom_GR4 or self.model==cst.tom_HBV, self.model==cst.tom_SAC_SMA, self.model==cst.tom_NAM):
             y[:,0] = self.myHydro[:,0]*self.surfaceDrained/3.6
         else:
             print("ERROR: this model was not implemented yet!")
@@ -1703,9 +1797,11 @@ class SubBasin:
             y_titles.append("Overland flow")
             y_titles.append("Interflow")
             y_titles.append("Total")
+        else:
+            y_titles.append("Total")
 
         if(Measures is not None):
-            y_titles.append("Measures")
+            y_titles.append("Measurement")
 
         # Colors of the plot
         myColors = []
@@ -1821,6 +1917,9 @@ class SubBasin:
             # nbElements = 3
             nbElements = 1
             lastElement = 0
+        else:
+            nbElements = 1
+            lastElement = 0
 
 
         # Take into account any additionnal data given and add it to plot
@@ -1882,7 +1981,8 @@ class SubBasin:
         tmpSum = np.zeros(len(myOutFlow)-lastElement)
         # y = np.zeros((len(self.outFlow)-lastElement,nbElements))
         y = []
-        if(self.model==cst.tom_UH or self.model==cst.tom_2layers_linIF or self.model==cst.tom_2layers_UH or cst.tom_GR4):
+        if(self.model==cst.tom_UH or self.model==cst.tom_2layers_linIF or self.model==cst.tom_2layers_UH or 
+           cst.tom_GR4 or cst.tom_HBV or cst.tom_SAC_SMA or cst.tom_NAM):
             if(withDelay):
                 # y[:,0] = self.outFlow[:-1]
                 y.append(myOutFlow[:])
@@ -1949,10 +2049,11 @@ class SubBasin:
             # y_titles.append("Interflow")
             # y_titles.append("Baseflow")
             # y_titles.append("Total")
-            y_titles.append('Débits simulés')
-        elif(self.model==cst.tom_UH or self.model==cst.tom_2layers_linIF or self.model==cst.tom_2layers_UH):
+            y_titles.append(_('Débits simulés'))
+        elif(self.model==cst.tom_UH or self.model==cst.tom_2layers_linIF or self.model==cst.tom_2layers_UH or 
+             self.model==cst.tom_HBV or self.model==cst.tom_SAC_SMA or self.model==cst.tom_NAM):
             if(ylabel==[]):
-                y_titles.append('Débits simulés')
+                y_titles.append(_('Débits simulés'))
                 # y_titles.append('Avec reconstruction Qout B. Vesdre')
                 # y_titles.append('Avec Qout décrit par Le Soir au B. Vesdre')
                 # y_titles.append('Débits nuls aux barrages')
@@ -1980,7 +2081,7 @@ class SubBasin:
 
         if(Measures is not None):
             # y_titles.append("Measures")
-            y_titles.append("Mesures")
+            y_titles.append("Measurement")
             # y_titles.append("Débits entrant reconstruits")
 
         # Colors of the plot
@@ -2307,6 +2408,14 @@ class SubBasin:
             myOutFlow *= 3.6/self.surfaceDrainedHydro
 
         return myOutFlow
+    
+
+    def get_outFlow_at_time(self, time:datetime.datetime, typeOutFlow:str="Net", unit:str='m3/s', whichOutFlow="", lag:float=0.0):
+        if time.tzname() != "UTC":
+            logging.warning(f"Time {time} is not in UTC! Be aware that the time will keep the time zone you defined !")
+
+        return self.get_outFlow(typeOutFlow=typeOutFlow, unit=unit, whichOutFlow=whichOutFlow, lag=lag)[np.where(self.time==time.timestamp())][0]
+
 
     def get_inlets(self, unit:str='m3/s', lag:float=0.0):
 
@@ -2421,13 +2530,20 @@ class SubBasin:
 
 
 
-    def plot_diff_cumulRain_with_lagtime(self, interval, lagTime, graph_title="", factor=1.5, writeDir="", lawNetRain=cst.tom_netRain_no, netRainParams={}):
+    def plot_diff_cumulRain_with_lagtime(self, interval=0.0, lagTime=0.0, graph_title="", factor=1.5, writeDir="", lawNetRain=cst.tom_netRain_no, netRainParams={}):
         """
         @var interval interval to consider in the gliding sum [sec]
         @var lagTime time to skip before applyihng the current rain [sec]
         """
-        nbIntervals = math.ceil(interval/self.deltaT)
-        nbLagSteps =  math.ceil(lagTime/self.deltaT)
+        if interval==0:
+            nbIntervals = len(self.myRain)
+        else:
+            nbIntervals = math.ceil(interval/self.deltaT)
+
+        if lagTime==0:
+            nbLagSteps = 0
+        else:
+            nbLagSteps =  math.ceil(lagTime/self.deltaT)
 
         if(lawNetRain==cst.tom_netRain_no):
             rain = self.myRain

wolfhece/hydrology/constant.py

@@ -19,6 +19,9 @@ tom_GR4                 = 6
 measures                = 5
 tom_2layers_linIF       = 7
 tom_2layers_UH          = 8
+tom_HBV                 = 9
+tom_SAC_SMA             = 10
+tom_NAM                 = 11
 compare_opti            = -1