wolfhece 2.0.5__py3-none-any.whl → 2.0.6__py3-none-any.whl

wolfhece/PyParams.py

@@ -66,8 +66,8 @@ def new_json(values:dict, fullcomment:str='') -> dict:
     """
     Create a new JSON string from values and fullcomment
 
-    @param values : values to store in the JSON string - dict of key:value - value must be integer
-    @param fullcomment : full comment to store in the JSON string - str - can be multiline with \n
+    :param values : values to store in the JSON string - dict of key:value - value must be integer
+    :param fullcomment : full comment to store in the JSON string - str - can be multiline with \n
     """
     return {"Values":values, "Full_Comment":fullcomment}
 
@@ -75,10 +75,10 @@ def new_infos_incr(groupname:str= None, paramname:str='nb', min:int=1, max:int=1
     """
     Create a new string for an incrementable group or parameter
 
-    @param groupname : name of the reference group (optional) -- if ommitted, the reference group is in the same group as the parameter
-    @param paramname : name of the reference parameter
-    @param min : minimum value
-    @param max : maximum value
+    :param groupname : name of the reference group (optional) -- if ommitted, the reference group is in the same group as the parameter
+    :param paramname : name of the reference parameter
+    :param min : minimum value
+    :param max : maximum value
     """
     if groupname is None:
         return paramname, str(min), str(max)
@@ -287,16 +287,16 @@ class Wolf_Param(wx.Frame):
         """
         Initialisation
 
-        @param parent : parent frame (wx.Window)
-        @param title : title of the frame
-        @param w : width of the frame
-        @param h : height of the frame
-        @param ontop : if True, the frame will be on top of all other windows
-        @param to_read : if True, the file will be read
-        @param filename : filename to read
-        @param withbuttons : if True, buttons will be displayed
-        @param DestroyAtClosing : if True, the frame will be destroyed when closed
-        @param toShow : if True, the frame will be displayed
+        :param parent : parent frame (wx.Window)
+        :param title : title of the frame
+        :param w : width of the frame
+        :param h : height of the frame
+        :param ontop : if True, the frame will be on top of all other windows
+        :param to_read : if True, the file will be read
+        :param filename : filename to read
+        :param withbuttons : if True, buttons will be displayed
+        :param DestroyAtClosing : if True, the frame will be destroyed when closed
+        :param toShow : if True, the frame will be displayed
 
 
         Callbacks (see 'set_callbacks'):
@@ -392,15 +392,15 @@ class Wolf_Param(wx.Frame):
 
         To activate a parameter, double-click on it in the default tab. It will be copied to the active tab and the value will be modifiable.
 
-        @param parent : parent frame
-        @param title : title of the frame
-        @param w : width of the frame
-        @param h : height of the frame
-        @param ontop : if True, the frame will be on top of all other windows
-        @param to_read : if True, the file will be read
-        @param withbuttons : if True, buttons will be displayed
-        @param DestroyAtClosing : if True, the frame will be destroyed when closed
-        @param toShow : if True, the frame will be displayed
+        :param parent : parent frame
+        :param title : title of the frame
+        :param w : width of the frame
+        :param h : height of the frame
+        :param ontop : if True, the frame will be on top of all other windows
+        :param to_read : if True, the file will be read
+        :param withbuttons : if True, buttons will be displayed
+        :param DestroyAtClosing : if True, the frame will be destroyed when closed
+        :param toShow : if True, the frame will be displayed
 
         """
 
@@ -608,11 +608,11 @@ class Wolf_Param(wx.Frame):
         """
         Routine interne de MAJ d'un paramètre
 
-        @param group : nom du groupe
-        @param param_name : nom du paramètre
-        @param isIncrementable : True si le paramètre est incrémentable
-        @param genGroup : generic name of an incrementable group
-        @param genParam : generic name of an incrementable param
+        :param group : nom du groupe
+        :param param_name : nom du paramètre
+        :param isIncrementable : True si le paramètre est incrémentable
+        :param genGroup : generic name of an incrementable group
+        :param genParam : generic name of an incrementable param
 
         """
 
@@ -1151,12 +1151,12 @@ class Wolf_Param(wx.Frame):
         """
         Add or update a parameter
 
-        @param groupname : groupe in which the new param will be strored - If it does not exist, it will be created
-        @param name      : param's name - If it does not exist, it will be created
-        @param value     : param'a value
-        @param type      : type -> will influence the GUI
-        @param comment   : param's comment -- helpful to understand the parameter
-        @param jsonstr   : string containing JSON data -- used in GUI
+        :param groupname : groupe in which the new param will be strored - If it does not exist, it will be created
+        :param name      : param's name - If it does not exist, it will be created
+        :param value     : param'a value
+        :param type      : type -> will influence the GUI
+        :param comment   : param's comment -- helpful to understand the parameter
+        :param jsonstr   : string containing JSON data -- used in GUI
         param whichdict  : where to store the param -- Default, Active or All, or IncGroup if the param is part of an incrementable group
 
         jsonstr can be a dict i.e. '{"Values":{choice1:1, choice2:2, choice3:3}, "Full_Comment":'Yeah baby !'}'
@@ -1633,14 +1633,14 @@ class Wolf_Param(wx.Frame):
         """
         Ajout d'un paramètre incrémentable
 
-        @param group: nom du groupe
-        @param name: nom du paramètre
-        @param value: valeur du paramètre
-        @param comment: commentaire du paramètre
-        @param type: type du paramètre
-        @param min: valeur minimale
-        @param max: valeur maximale
-        @param refParam: nom du paramètre contenant le nombre de paramètres - doit être dans le même groupe
+        :param group: nom du groupe
+        :param name: nom du paramètre
+        :param value: valeur du paramètre
+        :param comment: commentaire du paramètre
+        :param type: type du paramètre
+        :param min: valeur minimale
+        :param max: valeur maximale
+        :param refParam: nom du paramètre contenant le nombre de paramètres - doit être dans le même groupe
 
         """
 
@@ -1737,10 +1737,10 @@ class Wolf_Param(wx.Frame):
         """
         Routine interne de mise à jour d'un seul paramétre incrémentable
 
-        @param curIncParam : nom du paramètre incrémentable - contient $n$ à remplacer par le numéro
-        @param curGroup : nom du groupe de référence - ! peut être un groupe icrémentable !
-        @param genGroup : nom du groupe générique dans lequel sont stockés les informations sur le paramètre (key, value, min, max, ...)
-        @param withGUI : True si on est en mode GUI
+        :param curIncParam : nom du paramètre incrémentable - contient $n$ à remplacer par le numéro
+        :param curGroup : nom du groupe de référence - ! peut être un groupe icrémentable !
+        :param genGroup : nom du groupe générique dans lequel sont stockés les informations sur le paramètre (key, value, min, max, ...)
+        :param withGUI : True si on est en mode GUI
 
         """
 

wolfhece/PyVertex.py

@@ -5,7 +5,7 @@ try:
 except:
     msg=_('Error importing OpenGL library')
     msg+=_('   Python version : ' + sys.version)
-    msg+=_('   Please check your version of opengl32.dll -- conflict may exist between different fils present on your desktop')
+    msg+=_('   Please check your version of opengl32.dll -- conflict may exist between different files present on your desktop')
     raise Exception(msg)
 
 import math

wolfhece/PyVertexvectors.py

@@ -21,8 +21,8 @@ import geopandas as gpd
 import io
 from typing import Union, Literal
 
-from .textpillow import Font_Priority
 from .PyTranslate import _
+from .textpillow import Font_Priority
 from .CpGrid import CpGrid
 from .PyVertex import wolfvertex,getIfromRGB,getRGBfromI
 from .PyParams import Wolf_Param, key_Param, Type_Param
@@ -417,8 +417,8 @@ class vectorproperties:
         """
         Init the vector properties -- Compatibility with VB6, Fortran codes --> Modify with care
 
-        @param lines: list of lines from a file
-        @param parent: parent vector
+        :param lines: list of lines from a file
+        :param parent: parent vector
         """
 
         self.parent:vector
@@ -796,6 +796,39 @@ class vector:
         if fromshapely is not None:
             self.import_shapelyobj(fromshapely)
 
+
+    def get_normal_segments(self) -> np.ndarray:
+        """
+        Return the normals of each segment
+
+        The normals are oriented to the left
+        """
+
+        if self.nbvertices<2:
+            return None
+
+        xy = self.asnparray()
+        delta = xy[1:]-xy[:-1]
+        norm = np.sqrt(delta[:,0]**2+delta[:,1]**2)
+        normals = np.zeros_like(delta)
+        notnull = np.where(norm!=0)
+        normals[notnull,0] = -delta[notnull,1]/norm[notnull]
+        normals[notnull,1] = delta[notnull,0]/norm[notnull]
+
+        return normals
+
+    def get_center_segments(self) -> np.ndarray:
+        """
+        Return the center of each segment
+        """
+
+        if self.nbvertices<2:
+            return None
+
+        xy = self.asnparray()
+        centers = (xy[1:]+xy[:-1])/2.
+        return centers
+
     @property
     def nbvertices(self) -> int:
         return len(self.myvertices)
@@ -1083,6 +1116,9 @@ class vector:
         """
         Ajout de vertices depuis une matrice numpy -- shape = (nb_vert,2 ou 3)
         """
+        if xyz.dtype==np.int32:
+            xyz = xyz.astype(np.float64)
+
         if xyz.shape[1]==3:
             for cur in xyz:
                 self.add_vertex(wolfvertex(cur[0], cur[1], cur[2]))
@@ -2077,7 +2113,7 @@ class zone:
                 self.ymin=minsy[0]
                 self.ymax=maxsy[0]
 
-    def plot(self,prep=False):
+    def plot(self, prep:bool=False):
         """
         Graphique OpenGL
         """

wolfhece/Results2DGPU.py

@@ -281,6 +281,8 @@ class wolfres2DGPU(Wolfresults_2D):
 
         self.loaded_rough = True
 
+        self.head_blocks[getkeyblock(0)] = curblock.top.get_header()
+
         to_check =[curblock.waterdepth, curblock.qx, curblock.qy, curblock.rough_n]
         check = False
         for curarray in to_check:
@@ -351,9 +353,9 @@ class wolfres2DGPU(Wolfresults_2D):
 
         curblock = self.myblocks[getkeyblock(1,False)]
         if self.epsilon > 0.:
-            curblock.waterdepth.array=ma.masked_less_equal(wd_np.astype(np.float32).T,self.epsilon)
+            curblock.waterdepth.array=ma.masked_less_equal(wd_np.astype(np.float32).T, self.epsilon)
         else:
-            curblock.waterdepth.array=ma.masked_equal(wd_np.astype(np.float32).T,0.)
+            curblock.waterdepth.array=ma.masked_equal(wd_np.astype(np.float32).T, 0.)
 
         curblock.qx.array=ma.masked_where(curblock.waterdepth.array.mask,qx_np.astype(np.float32).T)
         curblock.qy.array=ma.masked_where(curblock.waterdepth.array.mask,qy_np.astype(np.float32).T)
@@ -362,10 +364,9 @@ class wolfres2DGPU(Wolfresults_2D):
         curblock.qx.count()
         curblock.qy.count()
 
-        if self.epsilon > 0.:
-            curblock.waterdepth.set_nullvalue_in_mask()
-            curblock.qx.set_nullvalue_in_mask()
-            curblock.qy.set_nullvalue_in_mask()
+        curblock.waterdepth.set_nullvalue_in_mask()
+        curblock.qx.set_nullvalue_in_mask()
+        curblock.qy.set_nullvalue_in_mask()
 
         self.current_result = which
         self.loaded=True

wolfhece/bernoulli/NetworkOpenGL.py

@@ -24,7 +24,7 @@ try:
 except:
     msg=_('Error importing OpenGL library')
     msg+=_('   Python version : ' + sys.version)
-    msg+=_('   Please check your version of opengl32.dll -- conflict may exist between different fils present on your desktop')
+    msg+=_('   Please check your version of opengl32.dll -- conflict may exist between different files present on your desktop')
     raise Exception(msg)
 
 from ..PyTranslate import _

wolfhece/cli.py

@@ -1,29 +1,36 @@
 
 def wolf():
+    """ Main wolf application : Map Manager"""
     from .apps.wolf import main
     main()
 
 def wolf2d():
+    """ Application for 2D simuations """
     from .apps.wolf2D import main
     main()
 
 def digitizer():
+    """ Application for digitizing curves """
     from .apps.curvedigitizer import main
     main()
 
 def params():
+    """ Application for managing parameters in WOLF format """
     from .apps.ManageParams import main
     main()
 
 def optihydro():
+    """ Application for hydrological optimisation """
     from .apps.Optimisation_hydro import main
     main()
 
 def hydro():
+    """ Application for hydrological simulations """
     from .apps.wolfhydro import main
     main()
 
 def compare():
+    """ Application for comparing 2D arrays """
     from .apps.wolfcompare2Darrays import main
     from PyTranslate import _
     from wolf_array import WolfArray

wolfhece/flow_SPWMI.py

@@ -570,7 +570,7 @@ class SPW_MI_flows():
         Le résultat est écrit dans des fichiers .csv dans le répertoire passé en argument
         Il est possible de restreindre le téléchargement entre deux années passées en argument
         Il est également possible de redémarrer le téléchargement depuis un index de station si l'opération s'est interrompue
-        @param
+        :param
         """
         dirout=normpath(dirout)
         mystations = list(self.code2name.keys())

wolfhece/friction_law.py

@@ -3,8 +3,8 @@ import math
 def f_barr_bathurst(k_sur_D,reynolds):
     """
         !> Evaluation du coefficient de frottement par Barr-Bathurst
-        !! @param k_sur_D : rugosité relative [-]
-        !! @param reynolds : nombre de Reynolds [-] au sens des conduites circulaires --> ATTENTION quand cette fonction est utilisée pour des écoulements à surface libre : Re' = 4*Re
+        !! :param k_sur_D : rugosité relative [-]
+        !! :param reynolds : nombre de Reynolds [-] au sens des conduites circulaires --> ATTENTION quand cette fonction est utilisée pour des écoulements à surface libre : Re' = 4*Re
         !! @author Louis Goffin
         !! @author Pierre Archambeau
         !!
@@ -44,8 +44,8 @@ def f_barr_bathurst(k_sur_D,reynolds):
 def f_colebrook(k_sur_D,reynolds):
     """
         !> Evaluation du coefficient de frottement par Colebrook
-        !! @param k_sur_D : rugosité relative [-]
-        !! @param reynolds : nombre de Reynolds [-] au sens des conduites circulaires --> ATTENTION quand cette fonction est utilisée pour des écoulements à surface libre : Re' = 4*Re
+        !! :param k_sur_D : rugosité relative [-]
+        !! :param reynolds : nombre de Reynolds [-] au sens des conduites circulaires --> ATTENTION quand cette fonction est utilisée pour des écoulements à surface libre : Re' = 4*Re
         !! @author Pierre Archambeau
         !!
         !! Formule implicite de Colebrook : \f$ \sqrt {\frac{1}{f}}  =  - 2\log \left[ {\frac{k}{{3,7D}} + \frac{{2,51}}{{Re \sqrt f }}} \right] =  - 2\log \left[ {\frac{k}{{14,8{R_h}}} + \frac{{2,51}}{{Re \sqrt f }}} \right] \f$
@@ -82,8 +82,8 @@ def f_colebrook(k_sur_D,reynolds):
 def f_colebrook_pure(k_sur_D,reynolds):
     """
     !> Evaluation du coefficient de frottement par Colebrook - pas de test si laminaire
-    !! @param k_sur_D : rugosité relative [-]
-    !! @param reynolds : nombre de Reynolds [-] au sens des conduites circulaires --> ATTENTION quand cette fonction est utilisée pour des écoulements à surface libre : Re' = 4*Re
+    !! :param k_sur_D : rugosité relative [-]
+    !! :param reynolds : nombre de Reynolds [-] au sens des conduites circulaires --> ATTENTION quand cette fonction est utilisée pour des écoulements à surface libre : Re' = 4*Re
     !! @author Pierre Archambeau
     !!
     !! Formule implicite de Colebrook : \f$ \sqrt {\frac{1}{f}}  =  - 2\log \left[ {\frac{k}{{3,7D}} + \frac{{2,51}}{{Re \sqrt f }}} \right] =  - 2\log \left[ {\frac{k}{{14,8{R_h}}} + \frac{{2,51}}{{Re \sqrt f }}} \right] \f$

wolfhece/gpuview.py

@@ -6,7 +6,7 @@ try:
 except:
     msg='Error importing OpenGL library'
     msg+='   Python version : ' + sys.version
-    msg+='   Please check your version of opengl32.dll -- conflict may exist between different fils present on your desktop'
+    msg+='   Please check your version of opengl32.dll -- conflict may exist between different files present on your desktop'
     raise Exception(msg)
 
 from math import sqrt,floor

wolfhece/hydrology/PyWatershed.py

@@ -1198,7 +1198,7 @@ class Watershed:
         isOk, fe_file = check_path(os.path.join(self.dir, "Coupled_pairs.txt"), prefix=self.dir)
         self.couplednodesxy=[]
         self.couplednodesij=[]
-        
+
         if isOk>=0:
             f = open(fe_file, 'r')
             lines = f.read().splitlines()
@@ -1358,7 +1358,7 @@ class Watershed:
             demdelta.array = 0.0
         else:
             demdelta = WolfArray(demdeltaFile)
-        # 
+        #
         slopes= WolfArray(self.dir+'\\Characteristic_maps\\Drainage_basin.slope',masknull=False)
         reaches= WolfArray(self.dir+'\\Characteristic_maps\\Drainage_basin.reachs')
         cnv= WolfArray(self.dir+'\\Characteristic_maps\\Drainage_basin.cnv')
@@ -1505,8 +1505,8 @@ class Watershed:
     def find_rivers(self, whichsub:int=0, whichreach:int=0) -> tuple[list[Node_Watershed], Node_Watershed]:
         """
         Recherche des mailles rivières
-        @param whichsub : numéro du sous-bassin à traiter
-        @param whicreach : numéro du tronçon à identifier
+        :param whichsub : numéro du sous-bassin à traiter
+        :param whicreach : numéro du tronçon à identifier
         """
         if whichsub>0 and whichsub<=self.nb_subs:
             if whichreach>0:
@@ -1530,7 +1530,7 @@ class Watershed:
     def find_sub(self, whichsub:int=0) -> list[Node_Watershed]:
         """
         Recherche des mailles du sous-bassin versant
-        @param whichsub : numéro du sous-bassin à traiter
+        :param whichsub : numéro du sous-bassin à traiter
         """
         if whichsub>0 and whichsub<=self.nb_subs:
             mysub=list(filter(lambda x: x.sub==whichsub, self.nodes))
@@ -1567,7 +1567,7 @@ class Watershed:
     def find_runoffnodes(self, whichsub:int=0) -> list[Node_Watershed]:
         """
         Recherche des mailles du bassin versant seul (sans les rivières)
-        @param whichsub : numéro du sous-bassin à traiter
+        :param whichsub : numéro du sous-bassin à traiter
         """
         if whichsub>0 and whichsub<=self.nb_subs:
             myrunoff=list(filter(lambda x: not x.river and x.sub==whichsub,self.nodes))
@@ -1603,7 +1603,7 @@ class Watershed:
     def find_flatnodes(self, listofsortednodes:list):
         """
         Recherche des mailles dans des zones de faibles pentes
-        @param listofsortednodes : liste triée de mailles
+        :param listofsortednodes : liste triée de mailles
         """
         myflatnodes=list(filter(lambda x: x.flatindex>-1,listofsortednodes))
 
@@ -1612,7 +1612,7 @@ class Watershed:
     def find_flatzones(self, listofsortednodes:list, maxindex:int):
         """
         Recherche des mailles dans des zones de faibles pentes
-        @param listofsortednodes : liste triée de mailles
+        :param listofsortednodes : liste triée de mailles
         """
         myflatzones=[[]] * maxindex
         for i in range(maxindex):
@@ -1964,7 +1964,7 @@ class Watershed:
         fig.canvas.draw()
 
     def update_times(self, wolf_time=None):
-        
+
         if wolf_time is None:
             wolf_time = WolfArray(self.dir+'\\Characteristic_maps\\Drainage_basin.time')
 
@@ -1972,4 +1972,3 @@ class Watershed:
             cur_node.time = wolf_time[cur_node.i, cur_node.j]
 
         self.to_update_times = False
-  

wolfhece/lagrangian/emitter.py

@@ -12,7 +12,7 @@ class Clock_Emitter():
         """
         Time manager for the emitter.
 
-        @param times: list of time intervals during which the emitter is active -- [[t_start1, t_end1], [t_start2, t_end2], ...]
+        :param times: list of time intervals during which the emitter is active -- [[t_start1, t_end1], [t_start2, t_end2], ...]
         """
         if isinstance(times, np.ndarray):
             assert times.ndim == 2, "times must be a 2D array - first line contains t_start, second line contains t_end"

wolfhece/lagrangian/example_domain.py

@@ -10,7 +10,7 @@ def circle_velocity_field(size:int=201, oxoy:tuple[float]=(0.,0.), dxdy:tuple[fl
     """
     Create a circle velocity field.
 
-    @param size: Size of the velocity field. (odd int)
+    :param size: Size of the velocity field. (odd int)
     """
     dx,dy = dxdy
     ox,oy = oxoy

wolfhece/lagrangian/velocity_field.py

@@ -158,10 +158,10 @@ class Velocity_2Fields_numba():
                  start_time:float,
                  delta_time:float) -> None:
         """
-        @param uv1 is the velocity field at time start_time
-        @param uv2 is the velocity field at time start_time + delta_time
-        @param start_time is the time of uv1
-        @param delta_time is the time between uv1 and uv2
+        :param uv1 is the velocity field at time start_time
+        :param uv2 is the velocity field at time start_time + delta_time
+        :param start_time is the time of uv1
+        :param delta_time is the time between uv1 and uv2
         """
 
         self.origx, self.origy = uv1.origx, uv1.origy