wolfhece 2.0.17__py3-none-any.whl → 2.0.18__py3-none-any.whl

wolfhece/ftp/downloader.py

@@ -6,16 +6,15 @@ import re
 MIT license: 2017 - Jwely
 
 Example usage:
-``` python
+
 import ftplib
 ftp = ftplib.FTP(mysite, username, password)
 download_ftp_tree(ftp, remote_dir, local_dir)
-```
 
 The code above will look for a directory called "remote_dir" on the ftp host, and then duplicate the
 directory and its entire contents into the "local_dir".
 
-*** Note that if wget is an option, I recommend using that instead ***
+Note that if wget is an option, I recommend using that instead
 
 """
 
@@ -81,14 +80,14 @@ def _file_name_match_patern(pattern, name):
 
 def _mirror_ftp_dir(ftp_handle, name, overwrite, guess_by_extension, pattern):
     """ replicates a directory on an ftp server recursively """
-    
+
     ftp_handle.cwd(name)
     files=[]
     ftp_handle.dir(files.append)
     files = [curf.split()[8] for curf in files]
     for item in files:
         if _is_ftp_dir(ftp_handle, item, guess_by_extension):
-                
+
             original_directory = os.getcwd()  # remember working directory before function is executed
             os.makedirs(item, exist_ok=True)
             os.chdir(item)  # change working directory to ftp mirror directory
@@ -106,14 +105,16 @@ def _mirror_ftp_dir(ftp_handle, name, overwrite, guess_by_extension, pattern):
 def download_ftp_tree(ftp_handle, path, destination, pattern=None, overwrite=False, guess_by_extension=True):
     """
     Downloads an entire directory tree from an ftp server to the local destination
+
     :param ftp_handle: an authenticated ftplib.FTP instance
     :param path: the folder on the ftp server to download
     :param destination: the local directory to store the copied folder
     :param pattern: Python regex pattern, only files that match this pattern will be downloaded.
     :param overwrite: set to True to force re-download of all files, even if they appear to exist already
     :param guess_by_extension: It takes a while to explicitly check if every item is a directory or a file.
-        if this flag is set to True, it will assume any file ending with a three character extension ".???" is
-        a file and not a directory. Set to False if some folders may have a "." in their names -4th position.
+
+    If this flag is set to True, it will assume any file ending with a three character extension ".???" is
+    a file and not a directory. Set to False if some folders may have a "." in their names -4th position.
     """
     path = path.lstrip("/")
     original_directory = os.getcwd()  # remember working directory before function is executed

wolfhece/gpuview.py

@@ -293,12 +293,12 @@ class VectorField(Element_To_Draw):
 
         """
         Logique de calcul :
-          - on normalise les composantes vectorielles --> [0, 1]
-          - on redistribue les normes entre [minsize , 1.] --> minsize==1 => toutes les flèches sont de taille identique
-          - on recalcule les composantes vectorielles sur base de cette nouvelle norme
-          - lors du dessin, on multiplie le facteur de mise à l'échelle par (self.zoom_factor * self.zoom_2)
-              - le premier facteur tient compte de la mise à l'échelle globale du champ vectoriel sur base d'une combinaison de blocs --> Wolfresults_2D
-              - le second facteur est purement graphique et sert à augmenter/réduire la taille tout en gardent la proportionnalité
+            - on normalise les composantes vectorielles --> [0, 1]
+            - on redistribue les normes entre [minsize , 1.] --> minsize==1 => toutes les flèches sont de taille identique
+            - on recalcule les composantes vectorielles sur base de cette nouvelle norme
+            - lors du dessin, on multiplie le facteur de mise à l'échelle par (self.zoom_factor * self.zoom_2)
+                - le premier facteur tient compte de la mise à l'échelle globale du champ vectoriel sur base d'une combinaison de blocs --> Wolfresults_2D
+                - le second facteur est purement graphique et sert à augmenter/réduire la taille tout en gardent la proportionnalité
         """
 
         self._set_data(x_extent, y_extent)
@@ -550,13 +550,14 @@ class VectorField(Element_To_Draw):
     def update_geometry(self, model_bounds: Rectangle, grid_bounds: Rectangle,
         nb_arrows_x: int, nb_arrows_y: int,
         arrow_scale_x: float, arrow_scale_y: float, aspect_ratio: float):
-        """ Model bounds: the coordinates of the full model we draw (world coord)
-            Grid bounds : the coordinates over which the grid will be computed (world coord);
-            nb_arrows: number of vector to plot in x/y dimension
-            expected to be a subset of model bounds.
-            arrow_scale : scale factor for arrows (expected to be used to maintain
-            the arrow size constant on screen)
-            aspect_ration: to adapt to screen's aspect ratio.
+        """
+        Model bounds: the coordinates of the full model we draw (world coord)
+        Grid bounds : the coordinates over which the grid will be computed (world coord);
+        nb_arrows: number of vector to plot in x/y dimension
+        expected to be a subset of model bounds.
+        arrow_scale : scale factor for arrows (expected to be used to maintain
+        the arrow size constant on screen)
+        aspect_ration: to adapt to screen's aspect ratio.
         """
 
         self._model_bounds = model_bounds

wolfhece/hydrology/Catchment.py

@@ -1384,8 +1384,8 @@ class Catchment:
             Structure du dictionnaire
             self.hyetoDict:
                 - Ordered To Nb: self.hyetoDict['Ordered To Nb'][nb] = iD
-                  , iD = hyeto nb of the file to read in the folder "Whole_basin". E.g.: the file "[iD]evap.hyeto"
-                  , nb = hyeto number sorted from 1 to nbHyeto. E.g.: if iD=['2', '5', '7'] => self.hyetoDict['Ordered To Nb'][2] = '5'
+                    - iD = hyeto nb of the file to read in the folder "Whole_basin". E.g.: the file "[iD]evap.hyeto"
+                    - nb = hyeto number sorted from 1 to nbHyeto. E.g.: if iD=['2', '5', '7'] => self.hyetoDict['Ordered To Nb'][2] = '5'
                 - Hyetos : self.hyetoDict['Hyetos'][nb]
                     - time: time array read in the .hyeto file
                     - rain: rain array read in the .hyeto file

wolfhece/hydrology/PyWatershed.py

@@ -303,8 +303,8 @@ class RiverSystem:
         Incrément d'index depuis l'amont jusque l'exutoire final
         Parcours des mailles rivières depuis tous les amonts et Incrémentation d'une unité
         Résultat :
-         - tous les biefs en amont sont à 1
-         - Les autres biefs contiennent le nombre de biefs en amont
+            - tous les biefs en amont sont à 1
+            - Les autres biefs contiennent le nombre de biefs en amont
 
         Indice de Strahler
         """

wolfhece/hydrology/SubBasin.py

@@ -1018,17 +1018,19 @@ class SubBasin:
 
 
     def compute_hydro(self):
-        """This procedure computes the total hydrograph and raw hydrograph of subbasin
-
-            The total hydrograph $q_{tot} is obtained with the formula:
-            \f[
-            q_{tot} = \sum q_{\text{inlets}} + q_{\text{me}}$
-            \f]
-            , with $q_{\text{me}}$ the hydrograph of the subbasin alone.
-
-            Internal variable changed: outFlowRaw, outFlow, inletsRaw
-            CAUTION: - Discussion about the ceil or the floor for the timeDelay indice!!!
-                     - UPDATE 2023.1 now the outFlow are not delayed anymore !!!! -> IMPORTANT UPDATE
+        """
+        This procedure computes the total hydrograph and raw hydrograph of subbasin
+
+        The total hydrograph $q_{tot} is obtained with the formula:
+        \f[
+        q_{tot} = \sum q_{\text{inlets}} + q_{\text{me}}$
+        \f]
+        , with $q_{\text{me}}$ the hydrograph of the subbasin alone.
+
+        Internal variable changed: outFlowRaw, outFlow, inletsRaw
+        CAUTION:
+            - Discussion about the ceil or the floor for the timeDelay indice!!!
+            - UPDATE 2023.1 now the outFlow are not delayed anymore !!!! -> IMPORTANT UPDATE
 
         """
         if(len(self._outFlow)==0):

wolfhece/hydrometry/kiwis_gui.py

@@ -14,15 +14,15 @@ import logging
 #Test de la présence de la fonction de traduction i18n "gettext" et définition le cas échéant pour ne pas créer d'erreur d'exécution
 import os
 import gettext
-if os.path.exists(os.path.dirname(__file__)+'\\..\\locales'):
-    t = gettext.translation('base', localedir=os.path.dirname(__file__)+'\\..\\locales', languages=['fr'])
-    t.install()
-else:
-    try:
-        t = gettext.translation('base', localedir='wolfhece\\locales', languages=['fr'])
-        t.install()
-    except:
-        pass
+# if os.path.exists(os.path.dirname(__file__)+'\\..\\locales'):
+#     t = gettext.translation('base', localedir=os.path.dirname(__file__)+'\\..\\locales', languages=['fr'])
+#     t.install()
+# else:
+#     try:
+#         t = gettext.translation('base', localedir='wolfhece\\locales', languages=['fr'])
+#         t.install()
+#     except:
+#         pass
 
 _=gettext.gettext
 

wolfhece/irm_qdf.py

@@ -162,7 +162,8 @@ class MontanaIRM():
         return fig,ax
 
 class Qdf_IRM():
-    """Gestion des relations QDF calculées par l'IRM
+    """
+    Gestion des relations QDF calculées par l'IRM
 
     Exemple d'utilisation :
 
@@ -178,11 +179,11 @@ class Qdf_IRM():
     myqdf = qdf.Qdf_IRM(name='Jalhay')
 
     Les données sont ensuite disponibles dans les propriétés, qui sont des "dataframes" pandas (https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html) :
-         - qdf           : les relation Quantité/durée/fréquence
-         - standarddev   : l'écart-type de l'erreur
-         - confintlow    : la valeur inférieure de l'intervalle de confiance (-2*stddev)
-         - confintup     : la valeur supérieure de l'intervalle de confiance (+2*stddev)
-         - montanacoeff  : les coeffciients de Montana
+        - qdf           : les relation Quantité/durée/fréquence
+        - standarddev   : l'écart-type de l'erreur
+        - confintlow    : la valeur inférieure de l'intervalle de confiance (-2*stddev)
+        - confintup     : la valeur supérieure de l'intervalle de confiance (+2*stddev)
+        - montanacoeff  : les coeffciients de Montana
 
     Il est par exemple possible d'accéder aux coefficients de Montana via l'une de ces lignes ou une combinaison :
 
@@ -285,8 +286,9 @@ class Qdf_IRM():
     def plot_idf(self,T=None,which='All',color=[27./255.,136./255.,245./255.]):
         """
         Plot IDF relations on a new figure
-        T       : the return period (based on RT constants)
-        which   : information to plot
+
+        :param T       : the return period (based on RT constants)
+        :param which   : information to plot
             - 'Montana'
             - 'QDFTable'
             - 'All'
@@ -325,8 +327,8 @@ class Qdf_IRM():
     def plot_qdf(self,T=None,which='All',color=[27./255.,136./255.,245./255.]):
         """
         Plot QDF relations on a new figure
-        T       : the return period (based on RT constants)
-        which   : information to plot
+        :param T       : the return period (based on RT constants)
+        :param which   : information to plot
             - 'Montana'
             - 'QDFTable'
             - 'All'