X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FSMESH%2Finput%2Fsmeshpy_interface.doc;h=df7e15967f55bcc6c0c1af93dff509fd40d880c3;hb=2a6e16b7faacf40cf3b91605690ce04f14141f1b;hp=6e2b421c9cb107e098ed6ae22ba0d967ffe5607d;hpb=79b1ac2b6df9117f16f11d444b1f165d477a1813;p=modules%2Fsmesh.git

diff --git a/doc/salome/gui/SMESH/input/smeshpy_interface.doc b/doc/salome/gui/SMESH/input/smeshpy_interface.doc
index 6e2b421c9..df7e15967 100644
--- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc
+++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc
@@ -1,41 +1,79 @@
 /*!
 
-\page smeshpy_interface_page Python interface smesh.py
+\page smeshpy_interface_page Python interface
 
-\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").
+Python API for SALOME %Mesh module defines several classes that can
+be used for easy mesh creation and edition.
 
-\n Please draw your attention to the below notes before address to
-the \ref smeshDC "documentation for smesh.py"
+Documentation for SALOME %Mesh module Python API is available in two forms:
+- <a href="smeshpy_doc/modules.html">Structured documentation</a>, where all methods and
+classes are grouped by their functionality, like it is done in the GUI documentation
+- <a href="smeshpy_doc/namespaces.html">Linear documentation</a> grouped only by classes, declared
+in the \ref smeshBuilder and \ref StdMeshersBuilder Python packages.
 
-\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 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 \ref smesh_migration_page
 
-\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.
+The SMESH python package contains helper functions to manipulate mesh elements and 
+interact with these elements.
 
-\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).
+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.
 
-\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.
+The functions are distributed in the python package \b salome.smesh.
 
-\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),
+\note
+The main package \b salome 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.
 
-\n others are based on commercial meshers:
-         - GHS3D(3D).
+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.
 
-\n \t To add hypotheses, please use interfaces, provided by the
-      assigned algorithms.
+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.
+
+Class \ref smeshBuilder.Mesh "Mesh" allows assigning algorithms to a mesh.
+Please note that some algorithms, included in the standard SALOME
+distribution are always available. Python package \ref StdMeshersBuilder "StdMeshersBuilder"
+provides an interface for standard meshing algorithms included into
+the SALOME %Mesh module distribution, like:
+- REGULAR (1D)
+- COMPOSITE (1D)
+- MEFISTO (2D)
+- Quadrangle (2D)
+- Hexa(3D)
+- etc ...
+
+To add meshing hypotheses, it is possible to use the functions provided by the
+algorithms interfaces.
+
+An example below demonstrates usage of the Python API for 3d mesh generation. 
+
+\anchor example_3d_mesh
+<h2>Example of 3d mesh generation:</h2>
+\tui_script{3dmesh.py}
+
+Examples of Python scripts for Mesh operations are available by
+the following links:
+
+- \subpage tui_creating_meshes_page
+- \subpage tui_cartesian_algo
+- \subpage tui_use_existing_faces
+- \subpage tui_viewing_meshes_page
+- \subpage tui_defining_hypotheses_page
+- \subpage tui_quality_controls_page
+- \subpage tui_filters_page
+- \subpage tui_grouping_elements_page
+- \subpage tui_modifying_meshes_page
+- \subpage tui_transforming_meshes_page
+- \subpage tui_notebook_smesh_page
+- \subpage tui_measurements_page
+- \subpage tui_generate_flat_elements_page
+- \subpage tui_work_on_objects_from_gui
+- \subpage tui_prism_3d_algo
 
 */