doc/docutils/overview.rst

   1
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3 General presentation of the GEOM python package
   4 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   5
   6 The GEOM python package essentially contains:
   7
   8 * The visualization of structural elements: a function to create
   9   geometrical 3D representations of mechanical models called
  10   "structural elements".
  11 * Utility functions to handle GEOM items in Salome study.
  12
  13 The functions are distributed in the python package
  14 ``salome.geom``. For example, the usage of the visualization of
  15 structural elements can be appreciated with this set of instructions:
  16
  17 .. code-block:: python
  18
  19    from salome.geom.structelem import TEST_StructuralElement
  20    TEST_StructuralElement()
  21
  22 This creates the geometrical objects displayed in the study below:
  23
  24 .. image:: /images/salome-geom-structuralelements.png
  25    :align: center
  26
  27 The specification of the programming interface of this package is
  28 detailled in the part :doc:`Documentation of the programming interface
  29 (API)</docapi>` of this documentation.
  30
  31 .. note::
  32    The main package ``salome`` contains other sub-packages that are
  33    distributed with the other SALOME modules. For example, the KERNEL
  34    module provides the python package ``salome.kernel`` and SMESH the
  35    package ``salome.smesh``.