wolfhece 2.2.30__py3-none-any.whl → 2.2.31__py3-none-any.whl

wolfhece/apps/version.py

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

wolfhece/pydownloader.py

@@ -0,0 +1,182 @@
+"""
+Author: HECE - University of Liege, Pierre Archambeau
+Date: 2025
+
+Copyright (c) 2025 University of Liege. All rights reserved.
+
+This script and its content are protected by copyright law. Unauthorized
+copying or distribution of this file, via any medium, is strictly prohibited.
+"""
+
+
+""" This module provides a downloader for the WOLFHECE dataset and other files freely available on the web. """
+
+import re
+import requests
+import ftplib
+from pathlib import Path
+from enum import Enum
+from typing import Union, Optional, List
+from collections import namedtuple
+import logging
+
+class DownloadType(Enum):
+    """ Enum to define the type of download. """
+    HTTP = 'http'
+    HTTPS = 'https'
+    FTP = 'ftp'
+
+class DownloadFiles(Enum):
+    """ Enum to define the files to download. """
+    WOLFARRAYS = ('bin', 'bin.txt')
+    TIFARRAYS = ('tif',)
+    TIFFARRAYS = ('tiff',)
+    SHPFILES = ('shp', 'dbf', 'shx', 'prj', 'cpg', 'sbn', 'sbx')
+    GPKGFILES = ('gpkg',)
+    VECFILES = ('vec', 'vec.extra')
+    VECZFILES = ('vecz', 'vecz.extra')
+    PROJECTFILES = ('proj',)
+
+class DonwloadDirectories(Enum):
+    """ Enum to define the directories for downloads. """
+    GDBFILES = ('gdb',)
+
+
+GITLAB_EXAMPLE = 'https://gitlab.uliege.be/HECE/wolf_examples/-/raw/main'
+DATADIR = Path(__file__).parent / 'data' / 'downloads'
+
+def clean_url(url: str) -> str:
+    """ Clean the URL by removing any query parameters or fragments.
+
+    :param url: The URL to clean.
+    :type url: str
+    :return: The cleaned URL.
+    :rtype: str
+    """
+    # Remove query parameters and fragments
+    cleaned_url = re.sub(r'\?.*|#.*', '', url)
+    # Remove trailing slashes
+    cleaned_url = re.sub(r'/+$', '', cleaned_url)
+    # Remove any leading or trailing whitespace
+    cleaned_url = cleaned_url.strip()
+    # Ensure slashes are consistent
+    cleaned_url = re.sub(r'(?<!:)//+', '/', cleaned_url)
+    # Convert Backslashes to forward slashes
+    cleaned_url = cleaned_url.replace('\\', '/')
+    # Ensure the URL starts with http:// or https://
+    if not cleaned_url.startswith(('http://', 'https://', 'ftp://')):
+        raise ValueError(f"Invalid URL: {url}. Must start with http://, https://, or ftp://")
+    return cleaned_url.strip()
+
+def download_file(url: str, destination: Union[str, Path] = None, download_type: DownloadType = DownloadType.HTTP, load_from_cache:bool = True) -> None:
+    """ Download a file from the specified URL to the destination path.
+
+    :param url: The URL of the file to download.
+    :param destination: The path where the file will be saved.
+    :param download_type: The type of download (HTTP, HTTPS, FTP).
+    :type url: str
+    :type destination: Union[str, Path]
+    :type download_type: DownloadType
+    :return: None
+    :raises requests.HTTPError: If the HTTP request fails.
+    """
+
+    url = str(url).strip()
+    # Clean the URL
+    url = clean_url(url)
+
+    if destination is None:
+        try:
+            destination = DATADIR / Path(url).parent.name / Path(url).name
+        except:
+            destination = DATADIR / Path(url).name
+    # create the directory if it does not exist
+    destination.parent.mkdir(parents=True, exist_ok=True)
+
+    suffix = Path(url).suffix.lower()
+    # remove point from the suffix for matching
+    if suffix.startswith('.'):
+        suffix = suffix[1:]
+
+    # Find the download type based on the URL suffix
+    for file_type_enum in DownloadFiles:
+        if suffix in file_type_enum.value:
+            file_type = file_type_enum
+            break
+
+    # Create a list of files to download based on the download type
+    # by replacing suffix in the url with the appropriate file extensions
+    to_download = []
+    to_destination = []
+    for ext in file_type.value:
+        if ext.startswith('.'):
+            ext = ext[1:]
+        to_download.append(url.replace(suffix, f'{ext}'))
+        to_destination.append(destination.with_suffix(f'.{ext}'))
+
+
+    if download_type == DownloadType.HTTP or download_type == DownloadType.HTTPS:
+
+        for url, destination in zip(to_download, to_destination):
+
+            if load_from_cache and destination.exists():
+                logging.info(f"File {destination} already exists. Skipping download.")
+                continue
+
+            if not url.startswith(('http://', 'https://')):
+                raise ValueError(f"Invalid URL: {url}. Must start with http:// or https://")
+
+            try:
+                response = requests.get(url)
+                response.raise_for_status()
+                with open(destination, 'wb') as file:
+                    file.write(response.content)
+            except requests.HTTPError as e:
+                logging.error(f"HTTP error occurred while downloading {url}: {e}")
+
+    elif download_type == DownloadType.FTP:
+
+        for url, destination in zip(to_download, to_destination):
+
+            if load_from_cache and destination.exists():
+                logging.info(f"File {destination} already exists. Skipping download.")
+                continue
+
+            if not url.startswith('ftp://'):
+                raise ValueError(f"Invalid URL: {url}. Must start with ftp://")
+
+            try:
+                parsed_url = ftplib.parse_ftp_url(url)
+                with ftplib.FTP(parsed_url.hostname) as ftp:
+                    ftp.login()
+                    with open(destination, 'wb') as file:
+                        ftp.retrbinary(f'RETR {parsed_url.path}', file.write)
+            except ftplib.all_errors as e:
+                logging.error(f"FTP error occurred while downloading {url}: {e}")
+    else:
+        raise ValueError(f"Unsupported download type: {download_type}")
+
+    return to_destination[0]
+
+def toys_dataset(dir:str, file:str, load_from_cache:bool = True):
+    """ Download toy files from the WOLFHECE dataset.
+
+    :param dir: The directory where the file will be saved.
+    :param file: The name of the file to download.
+    :type dir: str
+    :type file: str
+    :return: The path to the downloaded file.
+    """
+    url = f"{GITLAB_EXAMPLE}/{dir}/{file}"
+    destination = DATADIR / dir / file
+    return download_file(url, destination, load_from_cache=load_from_cache)
+
+if __name__ == "__main__":
+    # Example usage
+    print(download_file(r'https:\\gitlab.uliege.be\HECE\wolf_examples\-\raw\main\Extract_part_array\extraction.vec'))
+    print(download_file('https://gitlab.uliege.be/HECE/wolf_examples/-/raw/main/Extract_part_array/extraction.vec'))
+    print(download_file('https://gitlab.uliege.be/HECE/wolf_examples/-/raw/main/Extract_part_array/Array_vector.proj'))
+    print(download_file('https://gitlab.uliege.be/HECE/wolf_examples/-/raw/main/Array_Theux_Pepinster/mnt.bin'))
+    print(download_file('https://gitlab.uliege.be/HECE/wolf_examples/-/raw/main/Array_Theux_Pepinster/mnt.tif'))
+    print(download_file('https://gitlab.uliege.be/HECE/wolf_examples/-/raw/main/PICC/PICC_Vesdre.shp'))
+    print(toys_dataset('Extract_part_array', 'extraction.vec'))

wolfhece/pypolygons_scen.py

@@ -25,7 +25,7 @@ from .drawing_obj import Element_To_Draw
 from .PyTranslate import _
 from .wolfresults_2D import views_2D, Wolfresults_2D
 from .Results2DGPU import wolfres2DGPU
-from .pybridges import stored_values_pos,stored_values_unk, parts_values, operators, stored_values_coords
+from .pybridges import stored_values_pos, stored_values_unk, parts_values, operators, stored_values_coords
 
 from zipfile import ZIP_DEFLATED, ZipFile
 
@@ -48,8 +48,8 @@ class Extracting_Zones(Zones):
     def __init__(self, filename='', ox: float = 0, oy: float = 0, tx: float = 0, ty: float = 0, parent=None, is2D=True, idx: str = '', plotted: bool = True, mapviewer=None, need_for_wx: bool = False) -> None:
         super().__init__(filename, ox, oy, tx, ty, parent, is2D, idx, plotted, mapviewer, need_for_wx)
 
-        self.parts:dict = None
-        self.linked:Union[dict, list] = None
+        self.parts:dict = None # Store the values inside the polygons - dict[dict] or dict[list]
+        self.linked:Union[dict, list] = None # Object from which the values are extracted - dict or list
 
     def cache_data(self, outputfile:str):
         """
@@ -163,14 +163,11 @@ class Extracting_Zones(Zones):
                                 locdict[cursim] = np.array([np.array([ tuple(lst1), np.array(lst2, dtype= np.int32)], dtype=object ) for lst1, lst2 in curnparray], dtype=object)
 
 
-    def find_values_inside_parts(self, linked_arrays):
+    def find_values_inside_parts(self, linked_arrays: dict | list):
         """
-        Récupère les valeurs à l'intérieur de la zone
+        Get values inside the polygons defined in the zones.
 
-        Retour :
-         - dictionnaire dont la clé est le nom (ou l'index) du polygone dans la zone --> parties centrale, amont ou aval
-         - chaque entrée est un dictionnaire dont la clé 'values' contient un dictionnaire pour chaque matrice du projet
-         - chaque élément de ce sous-dictionnaire est un tuple contenant toutes les valeurs utiles
+        :param linked_arrays: list or dict of arrys/simulations to link with the polygons.
 
         ***
         ATTENTION : si linked_arrays est un dictionnaire, alors un niveau supérieur est ajouté sur base des clés de ce dictionnaire, dans ce cas, self.linked est un dict et non une liste
@@ -179,6 +176,7 @@ class Extracting_Zones(Zones):
         """
         if isinstance(linked_arrays, dict):
 
+            self.linked = {}
             for curkey, curgroup in linked_arrays.items():
                 self.linked[curkey] = [(curlink.idx, type(curlink)) for curlink in curgroup]
 

wolfhece/wolf_array.py

@@ -111,6 +111,11 @@ except ImportError as e:
     print(e)
     raise Exception(_('Error importing modules'))
 
+try:
+    from .pydownloader import download_file, toys_dataset
+except ImportError as e:
+    raise Exception(_('Error importing pydownloader module'))
+
 WOLF_ARRAY_HILLSHAPE = -1
 WOLF_ARRAY_FULL_SINGLE = 1
 WOLF_ARRAY_FULL_DOUBLE = 2
@@ -5605,6 +5610,14 @@ class WolfArray(Element_To_Draw, header_wolf):
 
         if fname is not None:
 
+            # check if fname is an url
+            if str(fname).startswith('http:') or str(fname).startswith('https:'):
+                try:
+                    fname = download_file(fname)
+                except Exception as e:
+                    logging.error(_('Error while downloading file: %s') % e)
+                    return
+
             self.filename = str(fname)
             logging.info(_('Loading file : %s') % self.filename)
             self.read_all()
@@ -6240,20 +6253,39 @@ class WolfArray(Element_To_Draw, header_wolf):
         if reset_plot:
             self.reset_plot()
 
-    def statistics(self, inside_polygon:vector | Polygon = None):
+    def statistics(self, inside_polygon:vector | Polygon | np.ndarray = None) -> dict[str, float | np.ndarray]:
         """
         Statistics on Selected data or the whole array if no selection
 
         :param inside_polygon: vector or Polygon to select data inside the polygon
         :return: mean, std, median, sum, volume (sum*dx*dy), values
+        :rtype: dict[str, float | np.ndarray]
+
+        Translated Keys are:
+            - _('Mean'): mean value of the selected data
+            - _('Std'): standard deviation of the selected data
+            - _('Median'): median value of the selected data
+            - _('Sum'): sum of the selected data
+            - _('Volume'): volume of the selected data (sum * dx * dy)
+            - _('Values'): values of the selected data as a numpy array
         """
 
         if inside_polygon is not None:
-            ij = self.get_ij_inside_polygon(inside_polygon)
+            if isinstance(inside_polygon, vector | Polygon):
+                ij = self.get_ij_inside_polygon(inside_polygon)
+            elif isinstance(inside_polygon, np.ndarray):
+                if inside_polygon.ndim == 2 and inside_polygon.shape[1] == 2:
+                    ij = self.get_ij_from_xy_array(inside_polygon)
+                else:
+                    logging.error(_('Invalid shape for inside_polygon numpy array'))
+                    return {}
+
             vals = self.array[ij[:,0], ij[:,1]]
+
         elif self.SelectionData.nb == 0 or self.SelectionData.myselection == 'all':
             logging.info(_('No selection -- statistics on the whole array'))
             vals = self.array[~self.array.mask].ravel().data	# all values
+
         else:
             vals = self.SelectionData.get_values_sel()
 
@@ -8996,7 +9028,7 @@ class WolfArray(Element_To_Draw, header_wolf):
           C'est le cas notamment de Wolfresults_2D
         """
 
-        return self.get_values_insidepoly(myvect, usemask,getxy)
+        return self.get_values_insidepoly(myvect, usemask, getxy)
 
     def get_all_values_underpoly(self, myvect: vector, usemask:bool=True, getxy:bool=False):
         """
@@ -10145,7 +10177,7 @@ class WolfArray(Element_To_Draw, header_wolf):
 
         return my_extr
 
-    def get_value(self, x:float, y:float, z:float=0., nullvalue:float=-99999):
+    def get_value(self, x:float, y:float, z:float=0., nullvalue:float=-99999, convert_to_float:bool=True):
         """
         Return the value at given coordinates
 
@@ -10180,8 +10212,10 @@ class WolfArray(Element_To_Draw, header_wolf):
             else:
                 value = nullvalue
 
-        #FIXME : forcing to convert to float is not a good idea
-        return float(value)
+        if convert_to_float:
+            return float(value)
+        else:
+            return value
 
     def get_xlim(self, window_x:float, window_y:float):
         """

{wolfhece-2.2.30.dist-info → wolfhece-2.2.31.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wolfhece
-Version: 2.2.30
+Version: 2.2.31
 Author-email: Pierre Archambeau <pierre.archambeau@uliege.be>
 Project-URL: Homepage, https://uee.uliege.be/hece
 Project-URL: Issues, https://uee.uliege.be/hece

{wolfhece-2.2.30.dist-info → wolfhece-2.2.31.dist-info}/RECORD

@@ -17,7 +17,7 @@ wolfhece/PyParams.py,sha256=BgTAwxxq831rYEq_KLcFBX_upjiSUpVtfoQnCxCNWUI,100443
 wolfhece/PyPictures.py,sha256=m1kY0saW6Y9Q0bDCo47lW6XxDkBrbQG-Fd8uVn8G5ic,2514
 wolfhece/PyTranslate.py,sha256=4appkmNeHHZLFmUtaA_k5_5QL-5ymxnbVN4R2OblmtE,622
 wolfhece/PyVertex.py,sha256=a56oY1NB45QnwARg96Tbnq-z-mhZKFkYOkFOO1lNtlk,51056
-wolfhece/PyVertexvectors.py,sha256=-MIgo6-PVir2NxQn6RoOdpEkqfrJv8Ts6_FjEZqXJC4,351630
+wolfhece/PyVertexvectors.py,sha256=MXoqgHVRMvpUOngqpErwT68JwUJo9FhEl1H4HB10-Zk,352574
 wolfhece/PyWMS.py,sha256=XcSlav5icct2UwV7K2r7vpxa5rKZWiHkp732lI94HFI,31534
 wolfhece/RatingCurve.py,sha256=bUjIrQjvIjkD4V-z8bZmA6pe1ILtYNM0-3fT6YUY1RU,22498
 wolfhece/RatingCurveData.py,sha256=5UvnIm89BwqjnEbLCcY3CA8WoFd_xHJbooNy62fX5iY,57660
@@ -26,7 +26,7 @@ wolfhece/ReadDataDCENN.py,sha256=vm-I4YMryvRldjXTvRYEUCxZsjb_tM7U9yj6OaPyD0k,153
 wolfhece/Results2DGPU.py,sha256=GTu7PMuwfH-xH8J7sVr6zq2CTkGKF24fG1ujEW62PtM,31598
 wolfhece/__init__.py,sha256=EnpZ2yDEXueP7GAKV0uA2vAwMiZFyBjDAFcL5Y7LzbM,1850
 wolfhece/_add_path.py,sha256=mAyu85CQHk0KgUI6ZizweeQiw1Gdyea9OEjGLC6lLA4,916
-wolfhece/analyze_poly.py,sha256=jsCUsd0ZJtTwSk5hekcXj8i0tGhH-WCfNkrBtPRJpCc,12715
+wolfhece/analyze_poly.py,sha256=gJlQZ0vwDG_N98eMDtUsLng9kKu-HlJ8a4xER9ubfDc,54527
 wolfhece/analyze_vect.py,sha256=3lkMwaQ4KRddBVRvlP9PcM66wZwwC0eCmypP91AW-os,6015
 wolfhece/cli.py,sha256=h1tSMHALiftktreyugKcjbASXfpJUm9UYMeVxR-MtG4,6424
 wolfhece/color_constants.py,sha256=Snc5RX11Ydi756EkBp_83C7DiAQ_Z1aHD9jFIBsosAU,37121
@@ -51,8 +51,9 @@ wolfhece/pidcontroller.py,sha256=PHYenOdzfyPK2pXAhyRolCxMSMRd2AFza0eVMafpPHk,520
 wolfhece/pyGui1D.py,sha256=9g7OS3YiKsqy--6y0cBD7x2gaqTTYFXWkxImpgnTA20,121937
 wolfhece/pybridges.py,sha256=bFAqjL4ColeJtwvyCPGQ8VllWoq1RbVWXxFrdfrvqm8,65954
 wolfhece/pydike.py,sha256=dRb6qGkqoTXjf107KcajcIk1F_FuMPaOZLSwixT3dgA,11196
+wolfhece/pydownloader.py,sha256=7vcxzllphhQcH0nEI2NwX-HC0bKhOVpDkODq54oFMbU,7136
 wolfhece/pylogging.py,sha256=4TI8hgBB65z-zpvU5Rfa2jkPXPhJaqXjHVPwbcdzTNc,4528
-wolfhece/pypolygons_scen.py,sha256=dG4zyJL_t5wgDqRfe-OqSH-fnxUt-su1H-tM3K3wHnc,46339
+wolfhece/pypolygons_scen.py,sha256=NWaNeK0RSUeOkgukeogK9FLmQiDjGZ9yhqs9208fojM,46237
 wolfhece/pyshields.py,sha256=KMtUO5kD0lisKnJD1NsDz-qaY5DpFcmS4O3WkXtUSmo,27898
 wolfhece/pyviews.py,sha256=zuZjWUptRDm1MTE1PN4Xj_qSITnojgDMG0LlFIBH3SE,13739
 wolfhece/pywalous.py,sha256=mWB7UxlYMIbPxNUDlONQEjcOOy9VSaRU9aYWZ5IFLu8,19164
@@ -60,7 +61,7 @@ wolfhece/rain_SPWMI.py,sha256=qCfcmF7LajloOaCwnTrrSMzyME03YyilmRUOqrPrv3U,13846
 wolfhece/textpillow.py,sha256=map7HsGYML_o5NHRdFg2s_TVQed_lDnpYNDv27MM0Vw,14130
 wolfhece/tools2d_dll.py,sha256=TfvvmyZUqEZIH0uHwUCJf0bdmCks_AiidDt23Unsp5w,13550
 wolfhece/tools_mpl.py,sha256=gQ3Jg1iuZiecmMqa5Eli2ZLSkttu68VXL8YmMDBaEYU,564
-wolfhece/wolf_array.py,sha256=15bCTr6nplKwGrkKR4vJR_NZCnhSZsoceUtV99Uy4C8,521981
+wolfhece/wolf_array.py,sha256=jin9_ntHASNcqMx0CPYFHMEIw-LaF6UnousSaQx3AxU,523441
 wolfhece/wolf_hist.py,sha256=fTEb60Q4TEwobdZsRU4CFXAId1eOKdWAqF8lnF1xEWc,3590
 wolfhece/wolf_texture.py,sha256=f4psYah1vqyeQjXz2O46d6qeKuv_Lzowk39O9Fmh_2g,20969
 wolfhece/wolf_tiles.py,sha256=v-HohqaWuMYdn75XLnA22dlloAG90iwnIqrgnB0ASQ4,10488
@@ -88,7 +89,7 @@ wolfhece/apps/curvedigitizer.py,sha256=lEJJwgAfulrrWQc-U6ij6sj59hWN3SZl4Yu1kQxVz
 wolfhece/apps/hydrometry.py,sha256=lhhJsFeb4zGL4bNQTs0co85OQ_6ssL1Oy0OUJCzhfYE,656
 wolfhece/apps/isocurrent.py,sha256=dagmGR8ja9QQ1gwz_8fU-N052hIw-W0mWGVkzLu6C7I,4247
 wolfhece/apps/splashscreen.py,sha256=EdGDN9NhudIiP7c3gVqj7dp4MWFB8ySizM_tpMnsgpE,3091
-wolfhece/apps/version.py,sha256=TbVLaOlu0bvthJf8mZ0I5HvlwlTNg4-IrIDSbM0cAAU,388
+wolfhece/apps/version.py,sha256=5D9bE5dzDLfYPyBmgVoMOincHBhGAqYJzByZrRcBiy8,388
 wolfhece/apps/wolf.py,sha256=mRnjYsUu4KIsRuamdQWAINFMuwN4eJgMo9erG-hkZ70,729
 wolfhece/apps/wolf2D.py,sha256=4z_OPQ3IgaLtjexjMKX9ppvqEYyjFLt1hcfFABy3-jU,703
 wolfhece/apps/wolf_logo.bmp,sha256=ruJ4MA51CpGO_AYUp_dB4SWKHelvhOvd7Q8NrVOjDJk,3126
@@ -307,8 +308,8 @@ wolfhece/ui/wolf_multiselection_collapsiblepane.py,sha256=u4C7CXe_bUyGKx7c_Bi0x9
 wolfhece/ui/wolf_times_selection_comparison_models.py,sha256=ORy7fz4dcp691qKzaOZHrRLZ0uXNhL-LIHxmpDGL6BI,5007
 wolfhece/wintab/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wolfhece/wintab/wintab.py,sha256=8A-JNONV6ujgsgG3lM5Uw-pVgglPATwKs86oBzzljoc,7179
-wolfhece-2.2.30.dist-info/METADATA,sha256=6DgxvLnytFPLyQpPZ2b0ZoyBqOe-rb98b-jm6FTw9Os,2729
-wolfhece-2.2.30.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-wolfhece-2.2.30.dist-info/entry_points.txt,sha256=Jr187pyvA3EeJiQLjZK9yo6mJX7IAn6ygZU9T8qF_gQ,658
-wolfhece-2.2.30.dist-info/top_level.txt,sha256=EfqZXMVCn7eILUzx9xsEu2oBbSo9liWPFWjIHik0iCI,9
-wolfhece-2.2.30.dist-info/RECORD,,
+wolfhece-2.2.31.dist-info/METADATA,sha256=FCE-JySySzwE8OSrK7O7_8IIPOg9RBfBVDS8sPiXfek,2729
+wolfhece-2.2.31.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+wolfhece-2.2.31.dist-info/entry_points.txt,sha256=Jr187pyvA3EeJiQLjZK9yo6mJX7IAn6ygZU9T8qF_gQ,658
+wolfhece-2.2.31.dist-info/top_level.txt,sha256=EfqZXMVCn7eILUzx9xsEu2oBbSo9liWPFWjIHik0iCI,9
+wolfhece-2.2.31.dist-info/RECORD,,