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 - Python Interface \subpage geompy_page "geomBuilder.py" to import/export, create and transform geometrical objects and use measurement tools;
   8 - Utility functions <em>geomtools.py</em> to handle %GEOM items in Salome study:
   9   - add or remove a shape;
  10   - display or erase a shape in the viewer;
  11   - completely delete a shape (undisplay, unpublish, and destroy it);
  12   - manage the selection in the object browser
  13   See for example how to \subpage manipulate_object "Manipulate a GEOM object in the study".
  14 - Wrapping functions for %GEOM tools:
  15   - sketcher module to create sketches from the python API (gsketcher.py)
  16 - \subpage struct_elem_visualisation "Visualization of structural elements" function to create
  17   geometrical 3D representations of mechanical models called
  18   "structural elements" (package \ref structelem.py "structelem")
  19
  20 The functions are distributed in the python package <em>salome.geom.</em>
  21 Its documentation is mainly generated from the code of source python files.
  22 <b>salome.geom</b> – Package containing the %GEOM python utilities:
  23 - <a href="geompy_doc/group__geomtools.html">geomtools</a>
  24 - <a href="geompy_doc/group__sketcher.html">sketcher</a>
  25 - <a href="geompy_doc/group__structelem.html">structelem</a>
  26
  27 \note The main package <em>salome</em> contains other sub-packages that are
  28 distributed with the other SALOME modules. For example, the KERNEL
  29 module provides the python package salome.kernel and SMESH the
  30 package salome.smesh.
  31 */