wolfhece 2.2.15__py3-none-any.whl → 2.2.17__py3-none-any.whl

wolfhece/hydrometry/kiwis.py

@@ -57,6 +57,8 @@ KIWIS WebServices command :
     checkValueLimit	checks value limitations for time range value requests
 """
 
+TIMEOUT = 5
+
 URL_SERVICE = 'https://hydrometrie.wallonie.be/services'
 URL_SERVICE_WATERINFO = 'https://download.waterinfo.be/tsmdownload'
 URL_SERVICE_HICWS = 'https://hicws.vlaanderen.be'
@@ -400,6 +402,13 @@ class hydrometry():
         if url=='':
             self.url=URL_SPW
 
+            # check if url is responding
+            try:
+                requests.get(self.url, timeout=TIMEOUT)
+            except requests.exceptions.RequestException as e:
+                logging.error(f"Error connecting to {self.url}: {e}")
+                return
+
         if urltoken=='':
             self.urltoken=URL_TOKEN
 
@@ -413,7 +422,7 @@ class hydrometry():
             self.get_sites()
             self.get_stations()
             self.get_groups()
-            self.save_struct(self.dir)
+            self.save_struct()
         except Exception as e:
             print('Error in hydrometry init :', e)
             self.realstations = None
@@ -501,7 +510,11 @@ class hydrometry():
         """
 
         if dir=='':
-            return
+            if self.dir:
+                dir = self.dir
+            else:
+                logging.warning('No directory to save structure')
+                return
 
         dir = Path(dir)
         dir.mkdir(parents=True, exist_ok=True)
@@ -572,7 +585,7 @@ class hydrometry():
         # returnfields += 'ts_id,ts_name,'
         # returnfields += 'ts_unitname,ts_unitsymbol,'
 
-        if self.dir!='' and self.get_path(self.dir, 'stations.csv').exists():
+        if self.dir!='' and self.get_path(self.dir,'stations.csv').exists():
             self.stations = pd.read_csv(self.get_path(self.dir, 'stations.csv'),index_col=0)
         elif self.url!='':
             try:
@@ -583,14 +596,16 @@ class hydrometry():
                                             +'&ca_sta_returnfields='+ca_sta_returnfields \
                                             +'&orderby=station_no', \
                                             verify=True, \
-                                            headers=self._header).json()
+                                            headers=self._header,
+                                            timeout=TIMEOUT).json()
                 else:
                     json_data = requests.get(self._get_commandstr(kiwis_command.getStationList, 'json') \
                                             +'&metadata=true' \
                                             +'&returnfields='+returnfields \
                                             +'&orderby=station_no', \
                                             verify=True, \
-                                            headers=self._header)
+                                            headers=self._header,
+                                            timeout=TIMEOUT)
 
                     json_data = json_data.text.replace('\x1a', ' ')
                     json_data = json.loads(json_data)
@@ -802,7 +817,9 @@ class hydrometry():
                                              '&timeseriesgroup_id='+str(group_id)+
                                              '&orderby=station_no'+
                                              returnFields,
-                                             verify=True, headers=self._header).json()
+                                             verify=True,
+                                             headers=self._header,
+                                             timeout=TIMEOUT).json()
                     stations = pd.DataFrame(json_data[1:], columns = json_data[0])
                 else:
                     logging.error(f'{time} not found in Enum')
@@ -831,7 +848,10 @@ class hydrometry():
                                      '&timeseriesgroup_id='+str(group_id)+
                                      '&orderby=station_no'+
                                      returnFields,
-                                     verify=True, headers=self._header).json()
+                                     verify=True,
+                                     headers=self._header,
+                                     timeout=TIMEOUT).json()
+
             stations = pd.DataFrame(json_data[1:], columns = json_data[0])
 
             return stations
@@ -844,7 +864,11 @@ class hydrometry():
         if self.dir!='' and self.get_path(self.dir, 'sites.csv').exists() and not forcerequest:
             self.sites = pd.read_csv(self.get_path(self.dir, 'sites.csv'),index_col=0)
         elif self.url!='' or forcerequest:
-            json_data = requests.get(self._get_commandstr(kiwis_command.getSiteList),verify=True, headers=self._header).json()
+            json_data = requests.get(self._get_commandstr(kiwis_command.getSiteList),
+                                     verify=True,
+                                     headers=self._header,
+                                     timeout=TIMEOUT).json()
+
             self.sites = pd.DataFrame(json_data[1:], columns = json_data[0])
         else:
             self.sites = None
@@ -857,7 +881,10 @@ class hydrometry():
         if self.dir!='' and self.get_path(self.dir, 'groups.csv').exists() and not forcerequest:
             self.groups = pd.read_csv(self.get_path(self.dir, 'groups.csv'),index_col=0)
         elif self.url!='' or forcerequest:
-            json_data = requests.get(self._get_commandstr(kiwis_command.getGroupList),verify=True, headers=self._header).json()
+            json_data = requests.get(self._get_commandstr(kiwis_command.getGroupList),
+                                     verify=True,
+                                     headers=self._header,
+                                     timeout=TIMEOUT).json()
             self.groups = pd.DataFrame(json_data[1:], columns = json_data[0])
         else:
             self.groups = None
@@ -878,7 +905,11 @@ class hydrometry():
         if self.dir!='' and self.get_path(self.dir, 'requests.csv').exists() and not forcerequest:
             self.requests = pd.read_csv(self.get_path(self.dir, 'requests.csv'),index_col=0)
         elif self.url!='' or forcerequest:
-            json_data = requests.get(self._get_commandstr(kiwis_command.getrequestinfo),verify=True, headers=self._header).json()
+            json_data = requests.get(self._get_commandstr(kiwis_command.getrequestinfo),
+                                     verify=True,
+                                     headers=self._header,
+                                     timeout=TIMEOUT).json()
+
             self.requests = pd.DataFrame(json_data[0]['Requests'])
         else:
             self.requests = None
@@ -913,7 +944,9 @@ class hydrometry():
         json_data = requests.get(self._get_commandstr(kiwis_command.getTimeseriesList)
                                  +'&station_id='+str(id)
                                  +'&format=json'
-                                 ,verify=True, headers=self._header).json()
+                                 ,verify=True,
+                                 headers=self._header,
+                                 timeout=TIMEOUT).json()
 
         try:
             if json_data[0] == 'No matches.':
@@ -978,7 +1011,7 @@ class hydrometry():
 
         id,list=self.timeseries_list(stationname=stationname,stationcode=stationcode)
         filename = self._get_filename_list(stationname,stationcode)
-        list.to_csv(dir / filename)
+        list.to_csv(self.get_path(dir,filename))
 
     def timeseries(self, stationname:str='', stationcode:str='', stationid:str='',
                    dir:str='',
@@ -1027,7 +1060,8 @@ class hydrometry():
                                         "station_id":str(id),
                                         "ts_name":ts_name,
                                         "timezone":timezone})
-                                        ,verify=True).json()
+                                        ,verify=True,
+                                        timeout=TIMEOUT).json()
                 if len(json_data)==1:
                     return None
 
@@ -1090,7 +1124,9 @@ class hydrometry():
                                     "to":todate.strftime("%Y-%m-%dT%H:%M:%S"),
                                     # "format":"json",
                                     "timezone":timezone})
-                                    ,verify=True, headers=self._header).json()
+                                    ,verify=True,
+                                    headers=self._header,
+                                    timeout=TIMEOUT).json()
 
             df = pd.DataFrame(json_data[0]['data'], columns = json_data[0]['columns'].split(','))
             df.set_index('Timestamp', inplace = True)
@@ -1139,7 +1175,8 @@ class hydrometry():
                                         "ts_name":ts_name,
                                         "timezone":timezone})+
                                         "&returnfields=Timestamp,Quality%20Code"
-                                        ,verify=True).json()
+                                        ,verify=True,
+                                        timeout=TIMEOUT).json()
                 if len(json_data)==1:
                     return None
 
@@ -1189,7 +1226,9 @@ class hydrometry():
                                     "to":todate.strftime("%Y-%m-%dT%H:%M:%S"),
                                     "timezone":timezone})+
                                     "&returnfields=Timestamp,Quality%20Code"
-                                    ,verify=True, headers=self._header).json()
+                                    ,verify=True,
+                                    headers=self._header,
+                                    timeout=TIMEOUT).json()
 
             df = pd.DataFrame(json_data[0]['data'], columns = json_data[0]['columns'].split(','))
             df.set_index('Timestamp', inplace = True)

wolfhece/lazviewer/laz_viewer.py

@@ -95,12 +95,12 @@ class Classification_LAZ():
             10 : ['Ponts', 'Les ponts ont été classés à part pour améliorer la définition du MNT. Ils ont été ouverts grâce',Colors.rgb_withalpha_float('lightyellow1',1.)],
             11 : ['Mur de berges', 'Mur et muret en berge de la Vesdre dépassant le sol à des vocation de réaliser une modélisation 3D hydraulique avec ces obstacles.',Colors.rgb_withalpha_float('red1',1.)],
             13 : ['Inconnu', 'A vérifier auSPW', Colors.rgb_withalpha_float('lightslategray',.2)],
-            15 : ['Tranche d\'eau', 'Echo intermédiaire dans l\’eau n\’appartenant ni à la surface d\’eau ni au fond du lit', Colors.rgb_withalpha_float('lightblue',.2)],
-            16 : ['Surface bathymétrique', 'Fond du lit de la Vesdre et de ses affluents et des autres surfaces d\’eau mesurées à partir du scanner 3 FWF discrétisé',Colors.rgb_withalpha_float('sandybrown',1.)],
+            15 : [r'Tranche d\'eau', r'Echo intermédiaire dans l\’eau n\’appartenant ni à la surface d\’eau ni au fond du lit', Colors.rgb_withalpha_float('lightblue',.2)],
+            16 : ['Surface bathymétrique', r'Fond du lit de la Vesdre et de ses affluents et des autres surfaces d\’eau mesurées à partir du scanner 3 FWF discrétisé',Colors.rgb_withalpha_float('sandybrown',1.)],
             17 : ['Surface bathymétrique incertaine', 'Surface bathymétrique sur les zones peu profondes principalement sous végétation où les intensités des échos sont parfois trop faibles pour avoir la certitude qu\’ils représentent le fond de rivière. La classe 17 est néanmoins plus certaine que la classe 18. Elle est utilisée dans la génération des MNT par défaut.',Colors.rgb_withalpha_float('rosybrown',.5)],
-            19 : ['Surface d\eau calculée', 'Points sous échantillonnés de la surface d\’eau ayant servis à faire les calculs de correction de réfraction bathymétrique',Colors.rgb_withalpha_float('lightblue',.2)],
+            19 : [r'Surface d\eau calculée', r'Points sous échantillonnés de la surface d\’eau ayant servis à faire les calculs de correction de réfraction bathymétrique',Colors.rgb_withalpha_float('lightblue',.2)],
             20 : ['Surface bathymétrique incertaine profonde', 'Surface bathymétrique sur les zones plus profondes principalement au centre de la rivière où les intensités des échos sont parfois trop faibles pour avoir la certitude qu\’ils représentent le fond de rivière. Non utilisée dans la génération du MNT. + Surface proche bathy mais potentiellement émergée pour les scanner 1 à 3',Colors.rgb_withalpha_float('lightblue',.5)],
-            29 : ['Surface d\'eau héliportée', 'La hauteur d\’eau du vol héliporté étant largement supérieure (de 30 à 40cm au vol Titan, les points matérialisant cette surface ont été reclassés dans cette classe séparée pour ne pas perturbé le reste du nuage de point.',Colors.rgb_withalpha_float('cyan',.3)]}
+            29 : [r'Surface d\'eau héliportée', r'La hauteur d\’eau du vol héliporté étant largement supérieure (de 30 à 40cm au vol Titan, les points matérialisant cette surface ont été reclassés dans cette classe séparée pour ne pas perturbé le reste du nuage de point.',Colors.rgb_withalpha_float('cyan',.3)]}
 
     def callback_colors(self):
         """ Update from wx GUI """

wolfhece/mesh2d/wolf2dprev.py

@@ -1748,6 +1748,29 @@ class prev_parameters_blocks:
 
             self.parent._scheme_centered_slope = 2
 
+    @property
+    def is_Manning_surface_friction(self) -> bool:
+        """ Retourne True si le modèle de surface de friction est de type Manning-Strickler """
+        i, name = self.get_params_surface_friction()
+        if i in [0, 1, 2, 3, 4, 5, 6, 7]:
+            return True
+        else:
+            return False
+
+    @property
+    def is_manning_strickler(self) -> bool:
+        """ Retourne True si le modèle de surface de friction est de type Manning-Strickler """
+        return self.is_Manning_surface_friction
+
+    @property
+    def is_Colebrook_surface_friction(self) -> bool:
+        """ Retourne True si le modèle de surface de friction est de type Colebrook """
+        i, name = self.get_params_surface_friction()
+        if i in [-3, -34, -5]:
+            return True
+        else:
+            return False
+
     def get_params_surface_friction(self) -> tuple[int, str]:
 
             if self._friction_law == 0:

wolfhece/pyshields.py

@@ -15,7 +15,7 @@ from scipy.optimize import root_scalar
 from typing import Literal
 import logging
 
-from .friction_law import f_barr_bathurst
+from .friction_law import f_barr_bathurst, f_colebrook, f_colebrook_pure
 
 RHO_PUREWATER = 1000. # kg/m3
 RHO_SEAWATER = 1025.  # kg/m3
@@ -530,6 +530,26 @@ def get_friction_slope_2D_Manning(q:float, h:float, n:float) -> float:
 
       return j
 
+def get_friction_slope_2D_Colebrook(q:float, h:float, K:float) -> float:
+      """
+      Compute friction slope j for 2D flow with Colebrook-White friction law
+
+      :param q : discharge [m3/s]
+      :param h : water depth [m]
+      :param K : Colebrook-White friction coefficient [m]
+      """
+
+      four_hydraulic_radius = 4.0 * h
+
+      if four_hydraulic_radius > 0.:
+            reynolds = (q/h) * four_hydraulic_radius / KIN_VISCOSITY # u*4h/nu == 4q/nu
+            k_sur_D = K / four_hydraulic_radius
+            j = f_colebrook(k_sur_D, reynolds) / four_hydraulic_radius * (q/h)**2.0/2.0/GRAVITY
+      else:
+            j = 0.
+
+      return j
+
 def get_shear_velocity_2D_Manning(q:float, h:float, n:float) -> float:
       """
       Compute shear velocity u_* for 2D flow with Manning/Strickler friction law
@@ -542,7 +562,23 @@ def get_shear_velocity_2D_Manning(q:float, h:float, n:float) -> float:
 
       j = get_friction_slope_2D_Manning(q,h,n)
 
-      ushear = (h*j*GRAVITY)**0.5
+      ushear = (GRAVITY*h*j)**0.5
+
+      return ushear
+
+def get_shear_velocity_2D_Colebrook(q:float, h:float, K:float) -> float:
+      """
+      Compute shear velocity u_* for 2D flow with Colebrook-White friction law
+
+      :param j : friction slope [-]
+      :param h : water depth [m]
+      :param q : discharge [m3/s]
+      :param K : Colebrook-White friction coefficient [m]
+      """
+
+      j = get_friction_slope_2D_Colebrook(q,h,K)
+
+      ushear = (GRAVITY*h*j)**0.5
 
       return ushear
 

wolfhece/wolf_array.py

@@ -7699,7 +7699,7 @@ class WolfArray(Element_To_Draw, header_wolf):
                                         self.nby)
                         cursel = [(x, y) for x in xall for y in yall]
 
-                    z = griddata(curlist, z, cursel, fill_value=np.NaN)
+                    z = griddata(curlist, z, cursel, fill_value=np.nan)
 
                     for cur, curz in zip(cursel, z):
                         if not np.isnan(curz):
@@ -7976,6 +7976,9 @@ class WolfArray(Element_To_Draw, header_wolf):
         if type(other) == float:
             if other != 0.:
                 newArray.array = np.ma.masked_array(self.array * other, self.array.mask, dtype=self.array.dtype)
+            else:
+                logging.debug(_('Multiplication by 0'))
+                newArray.array = np.ma.masked_array(self.array * other, self.array.mask, dtype=self.array.dtype)
         else:
             newArray.array = np.ma.masked_array(self.array * other.array, self.array.mask, dtype=self.array.dtype)
         newArray.count()
@@ -10065,7 +10068,8 @@ class WolfArray(Element_To_Draw, header_wolf):
                         figsize:tuple=None,
                         Walonmap:bool=False,
                         cat:str='IMAGERIE/ORTHO_2022_ETE',
-                        first_mask_data:bool=True):
+                        first_mask_data:bool=True,
+                        with_legend:bool=False):
         """
         Plot the array - Matplotlib version
 
@@ -10114,13 +10118,17 @@ class WolfArray(Element_To_Draw, header_wolf):
             - `'IMAGERIE/ORTHO_2023_ETE'`
             - `'IMAGERIE/ORTHO_LAST'`
         :type cat: str, optional (Default value = `'IMAGERIE/ORTHO_2022_ETE'`)
+        :param first_mask_data: If True, applies the mask to the data before plotting. Default is True.
+        :type first_mask_data: bool, optional (Default value = True)
+        :param with_legend: If True, adds a color legend to the plot. Default is False.
+        :type with_legend: bool, optional (Default value = False)
         :return: If `getdata_im` is False, returns (fig, ax), where `fig` is the Matplotlib figure and `ax` is the axis. If `getdata_im` is True, returns (fig, ax, im), where `im` is the image object created by `imshow`.
         :rtype: tuple
         """
 
         if first_mask_data:
             self.mask_data(self.nullvalue)
-    
+
         if update_palette:
             self.updatepalette(0)
 
@@ -10143,6 +10151,11 @@ class WolfArray(Element_To_Draw, header_wolf):
                 logging.error(_('Error while fetching the map image from WalOnMap'))
                 logging.error(e)
 
+        if vmin is None and vmax is not None:
+            vmin = self.mypal.values[0]
+        elif vmax is None and vmin is not None:
+            vmax = self.mypal.values[-1]
+
         if (vmin is None) and (vmax is None):
             # im = ax.imshow(self.array.transpose(), origin='lower', cmap=self.mypal,
             #         extent=(self.origx, self.origx + self.dx * self.nbx, self.origy, self.origy + self.dy * self.nby))
@@ -10155,8 +10168,23 @@ class WolfArray(Element_To_Draw, header_wolf):
                                    self.origx + self.dx * self.nbx,
                                    self.origy,
                                    self.origy + self.dy * self.nby),
-                            alpha=np.select([self.array.mask.T, ~self.array.mask.T], 
+                            alpha=np.select([self.array.mask.T, ~self.array.mask.T],
                                             [np.zeros(self.shape).T, np.ones(self.shape).T]))
+
+            if with_legend:
+                # add a legend in a new axis
+                ax_leg = fig.add_axes([0.92, 0.12, 0.04, 0.8])
+                from matplotlib.colorbar import ColorbarBase
+                from matplotlib import colors
+                cbar = ColorbarBase(ax_leg, cmap=self.mypal.cmap, norm=self.mypal.norm, orientation='vertical')
+                cbar.set_ticks(self.mypal.values)
+                cbar.set_ticklabels(self.mypal.values)
+                cbar.ax.tick_params(labelsize=8)
+                cbar.ax.yaxis.set_label_position('left')
+                cbar.ax.yaxis.set_ticks_position('right')
+                cbar.ax.yaxis.set_tick_params(width=0.5, size=2, direction='in', color='black')
+
+
         else:
             im = ax.imshow(self.array.transpose(),
                            origin='lower',
@@ -10166,9 +10194,29 @@ class WolfArray(Element_To_Draw, header_wolf):
                                    self.origy,
                                    self.origy + self.dy * self.nby),
                            vmin=vmin, vmax=vmax,
-                           alpha=np.select([self.array.mask.T, ~self.array.mask.T], 
+                           alpha=np.select([self.array.mask.T, ~self.array.mask.T],
                                            [np.zeros(self.shape).T, np.ones(self.shape).T])                           )
+
+
+            if with_legend:
+                # add a legend in a new axis
+                ax_leg = fig.add_axes([0.92, 0.12, 0.04, 0.8])
+                from matplotlib.colorbar import ColorbarBase
+                from matplotlib import colors
+                from matplotlib.colors import Normalize
+                cbar = ColorbarBase(ax_leg, cmap=self.mypal.cmap, norm= Normalize(vmin, vmax), orientation='vertical')
+                vals = list(np.linspace(vmin, vmax, self.mypal.nb, endpoint=True))
+                # limit to 2 decimal places
+                vals = [round(val, 2) for val in vals]
+                cbar.set_ticks(vals)
+                cbar.set_ticklabels(vals)
+                cbar.ax.tick_params(labelsize=8)
+                cbar.ax.yaxis.set_label_position('left')
+                cbar.ax.yaxis.set_ticks_position('right')
+                cbar.ax.yaxis.set_tick_params(width=0.5, size=2, direction='in', color='black')
+
         ax.set_aspect('equal')
+        fig.tight_layout()
 
         if getdata_im:
             return fig, ax, im
@@ -11434,7 +11482,7 @@ class WolfArrayMB(WolfArray):
         :param j: j index
         :param which_block: block index 1-based
         """
-        h = np.NaN
+        h = np.nan
         if which_block == 0:
             logging.warning("Block index is probably 0-based. It should be 1-based.")
             return h
@@ -11455,7 +11503,7 @@ class WolfArrayMB(WolfArray):
         Read the value at world coordinate (x,y). if `abs` is
         given, then the translation is is taken into account.
 
-        If no block covers the coordinate, then np.NaN is returned
+        If no block covers the coordinate, then np.nan is returned
         If several blocks cover the given coordinate then the first
         match is returned (and thus, the others are ignored).
 
@@ -11463,10 +11511,10 @@ class WolfArrayMB(WolfArray):
         :param y: y coordinate
         :param abs: if True, then the translation is taken into account
 
-        :return: the value at (x,y) or np.NaN if no block covers the coordinate
+        :return: the value at (x,y) or np.nan if no block covers the coordinate
         """
 
-        h = np.NaN
+        h = np.nan
         for curblock in self.myblocks.values():
             curblock: WolfArray
             nbx = curblock.nbx
@@ -12090,15 +12138,16 @@ class WolfArrayMB(WolfArray):
 
         return newArray
 
-    def plot_matplotlib(self, 
-                        figax:tuple=None, 
-                        getdata_im:bool=False, 
-                        update_palette:bool=True, 
-                        vmin:float=None, vmax:float=None, 
-                        figsize:tuple=None, 
-                        Walonmap:bool=False, 
+    def plot_matplotlib(self,
+                        figax:tuple=None,
+                        getdata_im:bool=False,
+                        update_palette:bool=True,
+                        vmin:float=None, vmax:float=None,
+                        figsize:tuple=None,
+                        Walonmap:bool=False,
                         cat:str='IMAGERIE/ORTHO_2022_ETE',
-                        first_mask_data:bool=True):
+                        first_mask_data:bool=True,
+                        with_legend:bool=False):
         """
         Plot the multi-block (MB) array - Matplotlib version
 
@@ -12150,6 +12199,10 @@ class WolfArrayMB(WolfArray):
             - `'IMAGERIE/ORTHO_2023_ETE'`
             - `'IMAGERIE/ORTHO_LAST'`
         :type cat: str, optional (Default value = `'IMAGERIE/ORTHO_2022_ETE'`)
+        :param first_mask_data: If True, applies the mask to the data before plotting. Default is True.
+        :type first_mask_data: bool, optional (Default value = True)
+        :param with_legend: If True, adds a color legend to the plot. Default is False.
+        :type with_legend: bool, optional (Default value = False)
         :return: If `getdata_im` is False, returns (fig, ax), where `fig` is the Matplotlib figure and `ax` is the axis. If `getdata_im` is True, returns (fig, ax, im), where `im` is the image object created by `imshow`.
         :rtype: tuple
         """
@@ -12157,14 +12210,15 @@ class WolfArrayMB(WolfArray):
         # Convert to single block
         single_block = self.as_WolfArray()
 
-        return single_block.plot_matplotlib(figax=figax, 
-                                            getdata_im=getdata_im, 
-                                            update_palette=update_palette, 
-                                            vmin=vmin, vmax=vmax, 
-                                            figsize=figsize, 
-                                            Walonmap=Walonmap, 
+        return single_block.plot_matplotlib(figax=figax,
+                                            getdata_im=getdata_im,
+                                            update_palette=update_palette,
+                                            vmin=vmin, vmax=vmax,
+                                            figsize=figsize,
+                                            Walonmap=Walonmap,
                                             cat=cat,
-                                            first_mask_data=first_mask_data)
+                                            first_mask_data=first_mask_data,
+                                            with_legend=with_legend)
 
 
 class WolfArrayMNAP(WolfArrayMB):