update __init__ + docstring kagome

ho_homog/mesh_generate/__init__.py

@@ -30,8 +30,8 @@ logger = logging.getLogger(__name__)  # http://sametmax.com/ecrire-des-logs-en-p
 
 
 __all__ = [
-    "kagome",
     "pantograph",
+    "kagome",
     "duplicate_pattern",
     "offset_pattern",
     "Gmsh2DRVE",
@@ -341,8 +341,8 @@ class Gmsh2DPart(object):
 
 
 from .pantograph import pantograph_RVE, pantograph_offset_RVE, beam_pantograph_RVE
-from .kagome import kagome_RVE
-from .kagome import kagome_sym_RVE
+from .kagome import kagome_RVE, kagome_sym_RVE
+
 
 # from .other_2d_microstructures import auxetic_square_RVE
 

ho_homog/mesh_generate/kagome.py

@@ -31,10 +31,28 @@ xdmf_parameters = dict(
 
 
 
-def kagome_RVE(alpha,name,r):
+def kagome_RVE(alpha,r,name=""):
+    """[summary]
+
+    Parameters
+    ----------
+    alpha : float
+        Paramètre d'ouverture, intervalle [0, 0.5]
+        0: configuration refermé
+        0.5: configuration complétement ouverte
+    name : str
+        
+    r : float
+        junction thinness, rayon de jonction / côté d'un triangle
+
+    La cellule est de taille constante,
+    par contre les triangles ont une taille qui dépend de l'angle d'ouverture.
+    """
     
     logger.info("Start defining the geometry")
 
+    name = name if name else "kagome"
+
     a = 1.0  # taille du réseau de triangle
     #alpha = 0.5# degré d'ouverture compris entre 0 et 0.5
     #r = a / 500  # rayon de jonction