X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FSMESH%2Finput%2Fsmeshpy_interface.doc;h=df7e15967f55bcc6c0c1af93dff509fd40d880c3;hb=18e7b9c7521fc13f643973ea953b08bdbf6dfbda;hp=2542a93e3abc36927c623b02878597a00b73a409;hpb=54182913fbb9df65a3f4cc96f55db3618835ecd8;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 2542a93e3..df7e15967 100644 --- a/doc/salome/gui/SMESH/input/smeshpy_interface.doc +++ b/doc/salome/gui/SMESH/input/smeshpy_interface.doc @@ -9,17 +9,36 @@ 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 - Linear documentation grouped only by classes, declared -in the \ref SMESH_SWIG.smeshBuilder "smeshBuilder" and \ref SMESH_SWIG.StdMeshersBuilder "StdMeshersBuilder" Python packages. +in the \ref smeshBuilder and \ref StdMeshersBuilder Python packages. -Class \ref SMESH_SWIG.smeshBuilder.smeshBuilder "smeshBuilder" provides an interface to create and handle +\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 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 \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. + +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 \ref SMESH_SWIG.smeshBuilder.Mesh "class Mesh" documentation. +methods, described in class \ref smeshBuilder.Mesh "Mesh" documentation. -Class \ref SMESH_SWIG.smeshBuilder.Mesh "Mesh" allows assigning algorithms to a mesh. +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 SMESH_SWIG.StdMeshersBuilder "StdMeshersBuilder" +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)