Salome HOME
Merge from BR_Dev_For_4_0 branch (from tag mergeto_BR_QT4_Dev_07Jul08)
[modules/smesh.git] / doc / salome / gui / SMESH / input / smeshpy_interface.doc
index 4fbf3d3b567efb134ab2a0e56f1a7694acbb446e..6e2b421c9cb107e098ed6ae22ba0d967ffe5607d 100644 (file)
@@ -5,6 +5,37 @@
 \n Python package smesh defines several classes, destined for easy and
 clear mesh creation and edition (see the \ref introduction_to_mesh_python_page "example").
 
-\n Also, please see \ref smeshDC "documentation for smesh.py"
+\n Please draw your attention to the below notes before address to
+the \ref smeshDC "documentation for smesh.py"
 
-*/
\ No newline at end of file
+\n 1. The main page of the \ref smeshDC "documentation for smesh.py"
+      contains a list of data structures and a list of functions,
+      provided by the package smesh.py. The first item in the data
+      structures list (\ref smeshDC::smeshDC "class smesh") also
+      represents documentation for methods of the package smesh.py itself.
+
+\n 2. Package smesh.py gives interface to create and manage
+      meshes. Please, use it to create an empty mesh or to import
+      it from data file.
+
+\n 3. Once you have created a mesh, you can manage it via its own
+      methods. See \ref smeshDC::Mesh "class Mesh" documentation for
+      them (it is also accessible by the second item "class Mesh" in the
+      data structures list).
+
+\n 4. Class Mesh allows to assign algorithms to a mesh.
+\n \t Please note, that there are always available some algorithms,
+      included in standard Salome installation:
+         - REGULAR(1D), COMPOSITE(1D), MEFISTO(2D), Quadrangle(2D), Hexa(3D), etc.
+
+\n Also there are some algorithms, which can be installed optionally,
+\n some of them are based on open-source meshers:
+         - NETGEN(1D-2D,2D,1D-2D-3D,3D),
+
+\n others are based on commercial meshers:
+         - GHS3D(3D).
+
+\n \t To add hypotheses, please use interfaces, provided by the
+      assigned algorithms.
+
+*/