doc/docutils/overview.rst

   1
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3 General presentation of the SMESH python package
   4 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   5
   6 The SMESH python package contains (today) helper functions to
   7 manipulate mesh elements and interact with these elements.
   8
   9 Note that these functions either encapsulate the python programming
  10 interface of SMESH core (the CORBA or SWIG interface for example) or
  11 extend existing utilities as the ``smesh.py`` module.
  12
  13 The functions are distributed in the python package
  14 ``salome.smesh``.
  15
  16 The specification of the programming interface of this package is
  17 detailled in the part :doc:`Documentation of the programming interface
  18 (API)</docapi>` of this documentation.
  19
  20 .. note::
  21    The main package ``salome`` contains other sub-packages that are
  22    distributed with the other SALOME modules. For example, the KERNEL
  23    module provides the python package ``salome.kernel`` and GEOM the
  24    package ``salome.geom``.