Salome HOME
0021746: EDF 2135 GEOM: Unification of Python documentations
[modules/smesh.git] / doc / salome / gui / SMESH / input / smeshpy_interface.doc
index 583eb1a8fb98b0dcd3e01d961464ec01795fff37..c3bb2ae184c92ebf2aa2102bfbac67e09b0631e9 100644 (file)
@@ -13,11 +13,26 @@ in the \ref smeshBuilder and \ref StdMeshersBuilder Python packages.
 
 \n With SALOME 7.2, the Python interface for %Mesh has been slightly modified to offer new functionality,
 \n You may have to modify your scripts generated with SALOME 6 or older versions.
-\n Please see <li>\ref smesh_migration_page</li>
+\n Please see \ref smesh_migration_page
+
+The SMESH python package contains helper functions to manipulate mesh elements and 
+interact with these elements.
+
+Note that these functions either encapsulate the python programming interface of SMESH core 
+(the CORBA or SWIG interface for example) or extend existing utilities as the smesh.py module.
+
+The functions are distributed in the python package \b salome.smesh.
+
+\note
+The main package \bsalome contains other sub-packages that are distributed with the other 
+SALOME modules. For example, the KERNEL module provides the python package \b salome.kernel 
+and GEOM the package \b salome.geom.
 
 Class \ref smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle
 meshes. It can be used to create an empty mesh or to import mesh from the data file.
 
+Class \ref smeshstudytools.SMeshStudyTools "SMeshStudyTools" provides several methods to manipulate mesh objects in Salome study. 
+
 As soon as mesh is created, it is possible to manage it via its own
 methods, described in class \ref smeshBuilder.Mesh "Mesh" documentation.