doc/salome/gui/GEOM/input/python_interface.doc

   1 /*!
   2
   3 \page python_interface Geometry module Python Interface
   4
   5 The %GEOM python package essentially contains:
   6
   7 - \subpage geompy_page "Python Interface geomBuilder.py" to perform the following functions:
   8   - Creating geometrical objects
   9   - Importing/exporting geometrical objects
  10   - Transforming geometrical objects
  11   - Using measurement tools
  12   - Field on Geometry
  13 - Utility functions to handle %GEOM items in Salome study (geomtools.py).
  14   See example - \subpage manipulate_object "Manipulate GEOM object in the study".
  15   - add a shape to a study, remove from the study
  16   - display a shape in a viewer, erase the shape from the viewers
  17   - completly delete a shape (undisplay, unpublish, and destroy the shape)
  18   - helper functions to manage the selection in the object browser
  19 - Wrapping functions to help the usage of %GEOM tools:
  20   - a sketcher module to create sketches from the python API (gsketcher.py)
  21 - \subpage struct_elem_visualisation "The visualization of structural elements": a function to create
  22   geometrical 3D representations of mechanical models called
  23   "structural elements" (package \ref structelem.py "structelem")
  24
  25 The functions are distributed in the python package salome.geom.
  26 The specification of the programming interface of this package
  27 is detailled in the part \subpage api_documentation "Documentation of the programming interface (API)"
  28 of this documentation.
  29
  30
  31 \note The main package salome contains other sub-packages that are
  32 distributed with the other SALOME modules. For example, the KERNEL
  33 module provides the python package salome.kernel and SMESH the
  34 package salome.smesh.
  35 */