X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FSMESH%2Finput%2Fsmeshpy_interface.doc;h=c690fb7efd8e5eb4a8e28a6a46877f627734233c;hb=38b7a09f609edfc0ff0f12a5e1f3f7c2c63845d8;hp=e725ef99cf237c4d8d012ac6cd3f0752efb768f4;hpb=bd4e115a78b52e3fbc016e5e30bb0e19b2a9e7d6;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 e725ef99c..c690fb7ef 100644 --- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc +++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc @@ -2,127 +2,52 @@ \page smeshpy_interface_page Python interface -Python package smesh defines several classes, destined for easy and -clear mesh creation and edition. +Python API for SALOME %Mesh module defines several classes that can +be used for easy mesh creation and edition. -Documentation for smesh package is available in two forms: - -The structured -documentation for smesh package, where all methods and +Documentation for SALOME %Mesh module Python API is available in two forms: +- Structured documentation, where all methods and classes are grouped by their functionality, like it is done in the GUI documentation -and the \ref smeshDC "linear documentation for smesh package" -grouped only by classes, declared in the smesh.py file. +- Linear documentation grouped only by classes, declared +in the \ref smeshBuilder and \ref StdMeshersBuilder Python packages. -The main page of the \ref smeshDC "linear documentation for smesh package" -contains a list of data structures and a list of -functions, provided by the package smesh.py. The first item in -the list of data structures (\ref smeshDC::smeshDC "class smesh") -also represents documentation for the 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 -The package smesh.py provides an interface to create and handle -meshes. Use it to create an empty mesh or to import it from the data file. +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. -Once a mesh has been created, it is possible to manage it via its own -methods, described at \ref smeshDC::Mesh "class Mesh" documentation -(it is also accessible by the second item "class Mesh" in the list of data structures). +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 \b Mesh allows assigning algorithms to a mesh. -Please note, that some algorithms, included in the standard SALOME -distribution are always available: +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... +- etc ... -To add hypotheses, use the interfaces, provided by the assigned -algorithms. +To add meshing hypotheses, it is possible to use the functions provided by the +algorithms interfaces. -Below you can see an example of usage of the package smesh for 3d mesh generation. +An example below demonstrates usage of the Python API for 3d mesh generation. \anchor example_3d_mesh