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

wolfhece/CpGrid.py

@@ -4,19 +4,16 @@ import wx.grid
 from .PyTranslate import _
 
 class CpGrid(wx.grid.Grid):
-    """ A Full Copy and Paste enabled grid class which implements Excel
-    like copy, paste, and delete functionality.
-
-    Ctrl+c - Copy range of selected cells.
-    Ctrl+v - Paste copy selection at point of currently selected cell.
-             If paste selection is larger than copy selection,
-             copy selection will be replicated to fill paste
-             region if it is a modulo number of copy rows and/or
-             columns, otherwise just the copy selection will be pasted.
-    Ctrl+x - Delete current selection. Deleted selection can be
-             restored with Ctrl+z, or pasted with Ctrl+v.
-             Delete or backspace key will also perform this action.
-    Ctrl+z - Undo the last paste or delete action.
+    """
+    A Full Copy and Paste enabled grid class which implements Excel like copy, paste, and delete functionality.
+
+        - Ctrl+c : Copy range of selected cells.
+        - Ctrl+v : Paste copy selection at point of currently selected cell.
+        - If paste selection is larger than copy selection, copy selection will be replicated to fill paste region if it is a modulo number of copy rows and/or columns, otherwise just the copy selection will be pasted.
+        - Ctrl+x : Delete current selection.
+        - Deleted selection can be restored with Ctrl+z, or pasted with Ctrl+v.
+        - Delete or backspace key will also perform this action.
+        - Ctrl+z : Undo the last paste or delete action.
 
     """
 

wolfhece/PyCrosssections.py

@@ -393,7 +393,7 @@ class profile(vector):
                               self.myvertices[-1].y-self.myvertices[0].y])
         self.orient = self.orient /np.linalg.norm(self.orient)
 
-    def get_xy_from_s(self,s) -> (float, float):
+    def get_xy_from_s(self,s) -> tuple[float, float]:
         """
         Récupération d'un tuple (x,y) sur base d'une distance 2D 's' orientée dans l'axe de la section
         """
@@ -672,7 +672,7 @@ class profile(vector):
 
         return length
 
-    def get_sz(self, cumul=True) -> (np.ndarray, np.ndarray):
+    def get_sz(self, cumul=True) -> tuple[np.ndarray, np.ndarray]:
         """
         Retourne 2 vecteurs avec la position curvi 2D et l'altitude des points
         """
@@ -729,7 +729,7 @@ class profile(vector):
             curvert = wolfvertex(xy[i,0],xy[i,1],sz[i,1])
             self.add_vertex(curvert)
 
-    def get_sz_banksbed(self, cumul=True, force:bool=False) -> (float, float, float, float, float, float):
+    def get_sz_banksbed(self, cumul=True, force:bool=False) -> tuple[float, float, float, float, float, float]:
         """
         Retourne les positions des points de référence  mais avec la coordonnée curvi 2D
          - (sleft, sbed, sright, zleft, zbed, zright)
@@ -791,10 +791,10 @@ class profile(vector):
 
         return sleft,sbed,sright,zleft,zbed,zright
 
-    def get_s3d_banksbed(self, force:bool=False)-> (float, float, float):
+    def get_s3d_banksbed(self, force:bool=False)-> tuple[float, float, float]:
         """
         Retourne les coordonnée curvi 3D des points de référence
-         - (sleft, sbed, sright)
+        - (sleft, sbed, sright)
         """
 
         if self.prepared and not force:
@@ -1678,11 +1678,11 @@ class crosssections(Element_To_Draw):
 
     L'objet stocke ses informations dans un dictionnaire : self.myprofiles
     Les clés de chaque entrée sont:
-        ['index']   : integer
-        ['left']    : wolfvertex
-        ['bed']     : wolfvertex
-        ['right']   : wolfvertex
-        ['cs']      : profile (surcharge de vector)
+        - ['index']   : integer
+        - ['left']    : wolfvertex
+        - ['bed']     : wolfvertex
+        - ['right']   : wolfvertex
+        - ['cs']      : profile (surcharge de vector)
 
     Pour le moment, il est possible de lire les fichiers et d'effectuer cerrains traitements (tri selon vecteur, export gltf...).
 
@@ -1694,6 +1694,7 @@ class crosssections(Element_To_Draw):
             - cloud_all
 
     @remark !! La classe n'est pas encore prévue pour créer des sections en travers!!
+
     """
 
     myprofiles:dict
@@ -2419,8 +2420,10 @@ class crosssections(Element_To_Draw):
         self.multils = self.asshapely_ls()
 
     def sort_along(self,vecsupport:LineString,name:str,downfirst=True):
-        """Sélectionne les sections qui intersectent un vecteur support
-        et les trie selon l'abscisse curviligne"""
+        """
+        Sélectionne les sections qui intersectent un vecteur support
+        et les trie selon l'abscisse curviligne
+        """
 
         curdict = self.sorted[name]={}
         curdict['support'] = vecsupport
@@ -2989,7 +2992,9 @@ class Interpolator():
         return xy,z
 
 class Interpolators():
-    """ Classe de gestion des interpolations sur sections en travers """
+    """
+    Classe de gestion des interpolations sur sections en travers
+    """
 
     def __init__(self, banks:Zones, cs:crosssections, ds=1.) -> None:
         """

wolfhece/PyHydrographs.py

@@ -86,8 +86,8 @@ class Hydrograph(pd.Series):
         """
         Read a wolf file at the format infil[n].tv and
         return its data as a dictionnary where:
-         - keys are times and,
-         - values are discharges.
+            - keys are times and
+            - values are discharges
 
         """
         data = {}

wolfhece/PyParams.py

@@ -110,10 +110,9 @@ class Wolf_Param(wx.Frame):
     **FR**
         Gestion des paramètres au format WOLF.
 
-        Fichier texte
-        -------------
+        **Fichier texte**
 
-        Les fichiers '*.param' sont des fichiers texte contenant des paramètres de type nom=valeur et compatibles avec les codes Fortran.
+        Les fichiers '.param' sont des fichiers texte contenant des paramètres de type nom=valeur et compatibles avec les codes Fortran.
         L'extension '.param.default' est utilisée pour stocker les paramètres par défaut.
 
         Une autre extension est possible mais un fichier '.default' sera créé automatiquement si ce fichier n'existe pas.
@@ -124,8 +123,7 @@ class Wolf_Param(wx.Frame):
 
         Les lignes débutant par '%' sont des commentaires. Il est possible d'ajouter du code JSON dans un commentaire. Pour cela, il faut ajouter '%json' au début de la ligne suivi d'un dictionnaire (e.g. %json{"Values":{'key1':1, 'key2':2}, "Full_Comment":"fullcomment"} ).
 
-        Organisation Python
-        -------------------
+        **Organisation Python**
 
         L'objet Python est basé sur des dictionnaires Python. Un dictionnaire par groupe de paramètres.
 
@@ -138,14 +136,12 @@ class Wolf_Param(wx.Frame):
             - comment : commentaire du paramètre (str) -- helpful to understand the parameter
             - added_json : dictionnaire contenant des informations supplémentaires (optionnel) -- permet de stocker des informations supplémentaires sur le paramètre (ex : valeurs possibles, commentaires étendus, ...)
 
-        Dictionnaires
-        -------------
+        **Dictionnaires**
 
         Il existe un dictionnaire de valeurs par défaut "myparams_default". Pour l'interaction Python-Fortran, c'est le Fortran qui écrit ces paramètres.
         Il existe un dictionnaire de paramètres actifs "myparams". Il est utilisé pour stocker les paramètres modifiés par l'utilisateur. Normalement, seuls les paramètres modifiés par l'utilisateur sont stockés dans ce dictionnaire et sont écrits sur disque.
 
-        Groupe/Paramètre incrémentable
-        ------------------------------
+        **Groupe/Paramètre incrémentable**
 
         Il est également possible de définir des groupes ou des paramètres incrémentables.
         Pour cela, dans le nom du groupe/paramètre, il faut ajouter, à l'emplacement souhaité du **numéro** du groupe/paramètre, des informations entre '$...$' :
@@ -160,14 +156,12 @@ class Wolf_Param(wx.Frame):
 
         Les informations génériques sont stockées dans les dictionnaires "myIncGroup" et "myIncParam".
 
-        UI
-        --
+        **UI**
 
         Une interface graphique est disponible pour modifier les paramètres. Elle est basée sur "wxPython" et la classe "wxPropertyGrid".
         L'attribut wx_exists permet de savoir si wxPython est en cours d'excution ou non.
 
-        Accès aux données
-        -----------------
+        **Accès aux données**
 
         Les paramètres sont accessibles via la procédure __getitem__ en fournissant un tuple (groupname, paramname).
         Il est possible de modifier un paramètre via la procédure __setitem__.
@@ -186,10 +180,9 @@ class Wolf_Param(wx.Frame):
     **EN**
         Management of parameters in WOLF format.
 
-        Text File
-        ----------
+        **Text File**
 
-        '*.param' files are text files containing parameters in the name=value format and compatible with Fortran codes.
+        '.param' files are text files containing parameters in the name=value format and compatible with Fortran codes.
         The '.param.default' extension is used to store default parameters.
 
         Another extension is possible, but a '.default' file will be automatically created if this file does not exist.
@@ -200,8 +193,7 @@ class Wolf_Param(wx.Frame):
 
         Lines starting with '%' are comments. It is possible to add JSON code in a comment. To do this, add '%json' at the beginning of the line followed by a dictionary (e.g., %json{"Values":{'key1':1, 'key2':2}, "Full_Comment":"fullcomment"}).
 
-        Python Organization
-        -------------------
+        **Python Organization**
 
         The Python object is based on Python dictionaries. One dictionary per parameter group.
 
@@ -214,14 +206,12 @@ class Wolf_Param(wx.Frame):
             - comment: parameter comment (str) -- helpful to understand the parameter
             - added_json: dictionary containing additional information (optional) -- used to store additional information about the parameter (e.g., possible values, extended comments, ...)
 
-        Dictionaries
-        -------------
+        **Dictionaries**
 
         There is a default values dictionary "myparams_default." For Python-Fortran interaction, Fortran writes these parameters.
         There is an active parameters dictionary "myparams." It is used to store parameters modified by the user. Normally, only parameters modified by the user are stored in this dictionary and written to disk.
 
-        Incrementable Group/Parameter
-        ------------------------------
+        **Incrementable Group/Parameter**
 
         It is also possible to define incrementable groups or parameters.
         To do this, in the group/parameter name, add information between '$...$' at the desired **number** location of the group/parameter:
@@ -236,14 +226,12 @@ class Wolf_Param(wx.Frame):
 
         Generic information is stored in the "myIncGroup" and "myIncParam" dictionaries.
 
-        UI
-        --
+        **UI**
 
         A graphical interface is available to modify parameters. It is based on "wxPython" and the "wxPropertyGrid" class.
         The wx_exists attribute indicates whether wxPython is currently running or not.
 
-        Data Access
-        -----------------
+        **Data Access**
 
         Parameters are accessible via the __getitem__ method by providing a tuple (groupname, paramname).
         It is possible to modify a parameter via the __setitem__ method.
@@ -258,7 +246,7 @@ class Wolf_Param(wx.Frame):
                 - for an incrementable parameter, by providing the necessary data in a string $n(refname,min,max)$ or $n(groupname,refname,min,max)$
                 - if the targeted group does not exist, it will be created if all information is available.
             - only add an incrementable parameter via the add_IncParam method.
-```
+
     """
 
     # Définition des propriétés

wolfhece/PyPictures.py

@@ -19,48 +19,51 @@ class Picture(wx.Frame):
     def __init__(self, *args, **kw):
         super().__init__(*args, **kw)
 
-
-# Spatial Reference System
-inputEPSG = 4326 #WGS84
-outputEPSG = 31370 #Lambert72
-
-# create coordinate transformation
-inSpatialRef = osr.SpatialReference()
-inSpatialRef.ImportFromEPSG(inputEPSG)
-
-outSpatialRef = osr.SpatialReference()
-outSpatialRef.ImportFromEPSG(outputEPSG)
-
-coordTransform = osr.CoordinateTransformation(inSpatialRef, outSpatialRef)
-
-dir = path.normpath(r'D:\OneDrive\OneDrive - Universite de Liege\Crues\2021-07 Vesdre\CSC - Convention - ARNE\3 noeuds critiques\tronçon 34')
-
-for curfile in listdir(dir):
-    filename,fileextent = path.splitext(curfile)
-    if fileextent.lower()=='.jpg':
-        img = Image(path.join(dir,curfile))
-
-        if img.get('Lambert72X'):
-            x = img.get('Lambert72X')
-            y = img.get('Lambert72Y')
-
-        elif img.get('gps_latitude'):
-            lat=img.gps_latitude
-            lon=img.gps_longitude
-            alt=img.gps_altitude
-
-            # create a geometry from coordinates
-            point = ogr.Geometry(ogr.wkbPoint)
-            if len(lat)==3:
-                lat = lat[0]+lat[1]/60+lat[2]/(60*60)
-                lon = lon[0]+lon[1]/60+lon[2]/(60*60)
-            point.AddPoint(lat, lon)
-            # transform point
-            point.Transform(coordTransform)
-            # print point in EPSG 31370
-            print(point.GetX(), point.GetY())
-            img.set('Lambert72X',point.GetX())
-            img.set('Lambert72Y',point.GetY())
-
-            with open(path.join(dir,'modified_image.jpg'), 'wb') as new_image_file:
-                new_image_file.write(img.get_file())
+def main():
+    # Spatial Reference System
+    inputEPSG = 4326 #WGS84
+    outputEPSG = 31370 #Lambert72
+
+    # create coordinate transformation
+    inSpatialRef = osr.SpatialReference()
+    inSpatialRef.ImportFromEPSG(inputEPSG)
+
+    outSpatialRef = osr.SpatialReference()
+    outSpatialRef.ImportFromEPSG(outputEPSG)
+
+    coordTransform = osr.CoordinateTransformation(inSpatialRef, outSpatialRef)
+
+    dir = path.normpath(r'D:\OneDrive\OneDrive - Universite de Liege\Crues\2021-07 Vesdre\CSC - Convention - ARNE\3 noeuds critiques\tronçon 34')
+
+    for curfile in listdir(dir):
+        filename,fileextent = path.splitext(curfile)
+        if fileextent.lower()=='.jpg':
+            img = Image(path.join(dir,curfile))
+
+            if img.get('Lambert72X'):
+                x = img.get('Lambert72X')
+                y = img.get('Lambert72Y')
+
+            elif img.get('gps_latitude'):
+                lat=img.gps_latitude
+                lon=img.gps_longitude
+                alt=img.gps_altitude
+
+                # create a geometry from coordinates
+                point = ogr.Geometry(ogr.wkbPoint)
+                if len(lat)==3:
+                    lat = lat[0]+lat[1]/60+lat[2]/(60*60)
+                    lon = lon[0]+lon[1]/60+lon[2]/(60*60)
+                point.AddPoint(lat, lon)
+                # transform point
+                point.Transform(coordTransform)
+                # print point in EPSG 31370
+                print(point.GetX(), point.GetY())
+                img.set('Lambert72X',point.GetX())
+                img.set('Lambert72Y',point.GetY())
+
+                with open(path.join(dir,'modified_image.jpg'), 'wb') as new_image_file:
+                    new_image_file.write(img.get_file())
+
+if __name__ == '__main__':
+    main()

wolfhece/PyVertexvectors.py

@@ -2928,12 +2928,10 @@ class zone:
 
         Retourne un dictionnaire contenant les valeurs pour chaque polygone
 
-        *****
         ATTENTION :
            Il est possible de choisir comme clé soit l'index du vecteur dans la zone, soit non nom
            Si le nom est choisi, cela peut aboutir à une perte d'information car il n'y a pas de certitude que les noms de vecteur soient uniques
            --> il est nécessaire que l'utilisateur soit conscient de cette possibilité
-        *****
 
         Les valeurs de chaque entrée du dict peuvent contenir une ou plusieurs listes en fonction du retour de la fonction de l'objet matriciel appelé
         """
@@ -3006,15 +3004,13 @@ class zone:
     def plot_linked_polygons(self, fig, ax, linked_arrays:dict, linked_vec:dict=None, linestyle='-', onlymedian=False, withtopography = True, ds:float = None):
         """
         Création d'un graphique sur base des polygones
+
         Chaque polygone se positionnera sur base de la valeur Z de ses vertices
-           --> façon conventionnelle de définir une longueur
-           --> ceci est normalement fait lors de l'appel à 'create_polygon_from_parallel'
-           --> si les polygones sont créés manuellement, il faut donc prendre soin de fournir l'information adhoc ou alors utiliser l'rgument 'ds'
+           - façon conventionnelle de définir une longueur
+           - ceci est normalement fait lors de l'appel à 'create_polygon_from_parallel'
+           - si les polygones sont créés manuellement, il faut donc prendre soin de fournir l'information adhoc ou alors utiliser l'rgument 'ds'
 
-        ***
-        ATTENTION :
-          Les coordonnées Z ne sont sauvegardées sur disque que si le fichier est 3D, autrement dit au format '.vecz'
-        ***
+        ATTENTION : Les coordonnées Z ne sont sauvegardées sur disque que si le fichier est 3D, autrement dit au format '.vecz'
 
         """
         colors=['red','blue','green','darkviolet','fuchsia','lime']
@@ -3202,19 +3198,18 @@ class Zones(wx.Frame, Element_To_Draw):
     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:
         """
         parent : soit une instance 'WolfMapViewer', soit une instance 'Ops_Array'
-           --> est utile pour transférer la propriété 'active_vector'
-               et obtenir diverses informations ou lancer des actions
+        --> est utile pour transférer la propriété 'active_vector' et obtenir diverses informations ou lancer des actions
 
-        wx_exists : si True --> permet l'affichage de la structure via WX car une app WX existe
-                    et est en cours d'exécution
+        wx_exists : si True --> permet l'affichage de la structure via WX car une app WX existe et est en cours d'exécution
 
         Si wx_exists alors on cherche une instance WolfMapViewer depuis le 'parent' --> set_mapviewer()
         Dans ce cas, le parent doit posséder une routine du type 'get_mapviewer()'
 
         Exemple :
-            def get_mapviewer(self):
-                # Retourne une instance WolfMapViewer
-                return self.mapviewer
+
+        def get_mapviewer(self):
+            # Retourne une instance WolfMapViewer
+            return self.mapviewer
         """
 
         Element_To_Draw.__init__(self, idx, plotted, mapviewer, need_for_wx)
@@ -4220,9 +4215,9 @@ class Zones(wx.Frame, Element_To_Draw):
         """
         Récupération des valeurs sous toutes les matrices liées pour le vecteur actif
 
-        Crée une nouvelle zone contenant une copie du vecteur
-        Le nombre de vertices est adapté pour correspondre au mieux à la matrice de liée
-         et ne pas perdre, si possible, d'information
+        Crée une nouvelle zone contenant une copie du vecteur.
+
+        Le nombre de vertices est adapté pour correspondre au mieux à la matrice de liée et ne pas perdre, si possible, d'information.
         """
         if self.parent is not None:
             if self.verify_activevec():

wolfhece/apps/curvedigitizer.py

@@ -11,6 +11,7 @@ import matplotlib.image as mpimg
 def main():
     """
     Main function of curve digitizer
+
     """
     plt.ion()
     ex = wx.App()
@@ -110,7 +111,9 @@ def getReferenceLength(index):
     Get the reference length in the requested direction
 
     USAGE: factor = getReferenceLength(index)
-    index = 0 for x-direction or 1 for y-direction
+
+    :param index : 0 for x-direction or 1 for y-direction
+
     """
 
     # define a 'direction' string

wolfhece/apps/wolfcompare2Darrays.py

@@ -16,10 +16,11 @@ except:
     from wolfhece.wolf_array import WolfArray
 
 def main(mydir:Path=None, ListArrays:list[WolfArray]=None):
-    """Comparaison de 2 cartes WOLF
-    args :
-        - mydir : répertoire contenant 2 matrices WOLF (ref.bin et comp.bin) et leurs fichiers accompagant
-        - ListArrays : liste de 2 objets WolfArray
+    """
+    Comparaison de 2 cartes WOLF
+
+    :param mydir : répertoire contenant 2 matrices WOLF (ref.bin et comp.bin) et leurs fichiers accompagant
+    :param ListArrays : liste de 2 objets WolfArray
     """
     if mydir is not None:
         assert isinstance(mydir,Path), _('mydir must be a Path object')
@@ -32,7 +33,7 @@ def main(mydir:Path=None, ListArrays:list[WolfArray]=None):
         assert isinstance(ListArrays,list), _('ListArrays must be a list')
         assert len(ListArrays)==2, _('ListArrays must contain 2 WolfArray objects')
         assert isinstance(ListArrays[0],WolfArray), _('ListArrays must contain 2 WolfArray objects')
-        assert isinstance(ListArrays[1],WolfArray), _('ListArrays must contain 2 WolfArray objects') 
+        assert isinstance(ListArrays[1],WolfArray), _('ListArrays must contain 2 WolfArray objects')
 
     #Déclaration de l'App WX
     ex = wx.App()
@@ -76,13 +77,16 @@ def main(mydir:Path=None, ListArrays:list[WolfArray]=None):
     ex.MainLoop()
 
 if __name__=='__main__':
-    """gestion de l'éxécution du module en tant que code principal"""
+    """
+    Gestion de l'éxécution du module en tant que code principal
+
+    """
     # total arguments
     n = len(sys.argv)
     # arguments
     print("Total arguments passed:", n)
     assert n in [2,3], _('Usage : wolfcompare <directory> or wolfcompare <file1> <file2>')
-    
+
     if n==2:
         mydir = Path(sys.argv[1])
         if mydir.exists():

wolfhece/clientserver/clientserver.py

@@ -0,0 +1,62 @@
+import wx
+import numpy as np
+import socket
+
+class Server(wx.Frame):
+
+    def __init__(self, parent, title):
+        super(Server, self).__init__(parent, title=title, size=(300, 200))
+        self.panel = wx.Panel(self)
+        self.text_ctrl = wx.TextCtrl(self.panel, style=wx.TE_MULTILINE)
+        self.button = wx.Button(self.panel, label="Send Matrix")
+        self.button.Bind(wx.EVT_BUTTON, self.on_send_matrix)
+        self.sizer = wx.BoxSizer(wx.VERTICAL)
+        self.sizer.Add(self.text_ctrl, proportion=1, flag=wx.EXPAND)
+        self.sizer.Add(self.button, proportion=0, flag=wx.EXPAND)
+        self.panel.SetSizer(self.sizer)
+        self.Show()
+
+    def on_send_matrix(self, event):
+        matrix = np.random.rand(3, 3)  # Example of a random matrix
+        self.text_ctrl.SetValue(str(matrix))
+
+        # Send matrix to client
+        host = '192.168.0.100'  # Replace with the IP address of the client PC
+        port = 12345  # Choose a suitable port number
+        with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
+            s.connect((host, port))
+            s.sendall(str(matrix).encode())
+
+class Client(wx.Frame):
+    def __init__(self, parent, title):
+        super(Client, self).__init__(parent, title=title, size=(300, 200))
+        self.panel = wx.Panel(self)
+        self.text_ctrl = wx.TextCtrl(self.panel, style=wx.TE_MULTILINE)
+        self.button = wx.Button(self.panel, label="Receive Matrix")
+        self.button.Bind(wx.EVT_BUTTON, self.on_receive_matrix)
+        self.sizer = wx.BoxSizer(wx.VERTICAL)
+        self.sizer.Add(self.text_ctrl, proportion=1, flag=wx.EXPAND)
+        self.sizer.Add(self.button, proportion=0, flag=wx.EXPAND)
+        self.panel.SetSizer(self.sizer)
+        self.Show()
+
+    def on_receive_matrix(self, event):
+        host = '192.168.0.100'  # Replace with the IP address of the server PC
+        port = 12345  # Choose the same port number used by the server
+        with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
+            s.connect((host, port))
+            matrix_str = s.recv(1024).decode()
+            try:
+                matrix = np.array(eval(matrix_str))
+                self.text_ctrl.SetValue(str(matrix))
+            except:
+                self.text_ctrl.SetValue("Invalid matrix format")
+
+def main():
+    app = wx.App()
+    Server(None, "Server")
+    Client(None, "Client")
+    app.MainLoop()
+
+if __name__ == '__main__':
+    main()

wolfhece/friction_law.py

@@ -2,21 +2,23 @@ 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
-        !! @author Louis Goffin
-        !! @author Pierre Archambeau
-        !!
-        !! source : TFE O. Machiels - "P:\Documentations\TFE\2008 - O. Machiels"
-        !!
-        !! La formule habituelle de Barr s'écrit en canalisation (p24 du TFE): \f$ \frac{1}{{\sqrt f }} =  - 2\log \left[ {\frac{{4,518\log \left( {\frac{{{Re} }}{7}} \right)}}{{{Re} \left( {1 + \frac{{{{{Re} }^{0,52}}{{\left( {\frac{k}{D}} \right)}^{0,7}}}}{{29}}} \right)}} + \frac{k}{{3,7D}}} \right] \f$
-        !!
-        !! Elle est étendue aux macro-rugosités via l'adjonction de la formule de Bathurst (!établie en surface libre!) (p27) : \f$ \sqrt {\frac{1}{f}}  =  - 1,987\log \frac{{{D_{84}}}}{{5,15h}} \f$
-        !!
-        !! La jonction entre les 2 suit un polynôme : \f$ {\frac{1}{{\sqrt f }} = 1469,76{{\left( {\frac{k}{h}} \right)}^3} - 382,83{{\left( {\frac{k}{h}} \right)}^2} + 9,89\left( {\frac{k}{h}} \right) + 5,22\quad pour\quad 0,05 < \frac{k}{h} < 0,15} \f$
-        !!
-        !! @remark Les bornes de validité des lois sont exprimées en k_sur_h, c'est-à-dire en 4*k_sur_D
+    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_prim = 4*Re
+
+    @author Louis Goffin
+    @author Pierre Archambeau
+
+    source : TFE O. Machiels - "P:\Documentations\TFE\2008 - O. Machiels"
+
+    La formule habituelle de Barr s'écrit en canalisation (p24 du TFE): \f$ \frac{1}{{\sqrt f }} =  - 2\log \left[ {\frac{{4,518\log \left( {\frac{{{Re} }}{7}} \right)}}{{{Re} \left( {1 + \frac{{{{{Re} }^{0,52}}{{\left( {\frac{k}{D}} \right)}^{0,7}}}}{{29}}} \right)}} + \frac{k}{{3,7D}}} \right] \f$
+
+    Elle est étendue aux macro-rugosités via l'adjonction de la formule de Bathurst (!établie en surface libre!) (p27) : \f$ \sqrt {\frac{1}{f}}  =  - 1,987\log \frac{{{D_{84}}}}{{5,15h}} \f$
+
+    La jonction entre les 2 suit un polynôme : \f$ {\frac{1}{{\sqrt f }} = 1469,76{{\left( {\frac{k}{h}} \right)}^3} - 382,83{{\left( {\frac{k}{h}} \right)}^2} + 9,89\left( {\frac{k}{h}} \right) + 5,22\quad pour\quad 0,05 < \frac{k}{h} < 0,15} \f$
+
+    @remark Les bornes de validité des lois sont exprimées en k_sur_h, c'est-à-dire en 4*k_sur_D
+
     """
     k_sur_h = 4.0*k_sur_D
 
@@ -43,19 +45,21 @@ 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
-        !! @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$
-        !!
-        !! Frottement laminaire en section circulaire \f$ \frac{64}{Re} \f$
-        !!
-        !! Transition par combinaison linéaire entre \f$ 800<Re<1000 \f$
-        !!
-        !! @remark  Une transition est assurée entre laminaire et turbulent afin de pouvoir utiliser cette fonction dans des procédures itératives
-        !!          du type Newton-Raphson qui supportent très mal les fonctions discontinues
+    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_prim = 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$
+
+    Frottement laminaire en section circulaire \f$ \frac{64}{Re} \f$
+
+    Transition par combinaison linéaire entre \f$ 800<Re<1000 \f$
+
+    @remark  Une transition est assurée entre laminaire et turbulent afin de pouvoir utiliser cette fonction dans des procédures itératives
+                du type Newton-Raphson qui supportent très mal les fonctions discontinues
 
     """
 
@@ -81,12 +85,13 @@ 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
-    !! @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$
+    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_prim = 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$
     """
 
     # !TURBULENT