2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 General presentation of the GEOM python package
4 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 The GEOM python package essentially contains:
8 * The visualization of structural elements: a function to create
9 geometrical 3D representations of mechanical models called
10 "structural elements".
12 Note that these functions either encapsulate the python programming
13 interface of GEOM core (the CORBA or SWIG interfaces for example) or
14 extend existing utilities as the ``geompy.py`` module.
16 The functions are distributed in the python package
17 ``salome.geom``. For example, the usage of the visualization of
18 structural elements can be appreciated with this set of instructions:
20 .. code-block:: python
22 from salome.geom.structelem import TEST_StructuralElement
23 TEST_StructuralElement()
25 This creates the geometrical objects displayed in the study below:
27 .. image:: /images/salome-geom-structuralelements.png
30 The specification of the programming interface of this package is
31 detailled in the part :doc:`Documentation of the programming interface
32 (API)</docapi>` of this documentation.
35 The main package ``salome`` contains other sub-packages that are
36 distributed with the other SALOME modules. For example, the KERNEL
37 module provides the python package ``salome.kernel`` and SMESH the
38 package ``salome.smesh``.