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