doc/salome/gui/GEOM/input/geompypkg.doc

   1 /*!
   2
   3 \page geompypkg_page Programming Interface of GEOM python package
   4
   5 Sorry, but the documentation is not available yet in doxygen format.
   6
   7 Fortunately, a documentation exists in restructured format and then
   8 can be generated here using sphinx, in the expectative of the doxygen
   9 version. This documentation is available <a href="../../tui/GEOM/docutils/index.html">
  10 here</a>.
  11
  12 Here is a sample generated from the doxygen format:
  13
  14 The GEOM python package essentially contains:
  15
  16 <ul>
  17   <li>The visualization of structural elements: a function to create
  18   geometrical 3D representations of mechanical models called
  19   "structural elements".
  20 </ul>
  21
  22 For details, you should refer to the complete
  23 <a href="../../tui/GEOM/docutils/index.html"> documentation of the GEOM
  24 python packages</a> generated with sphinx from rst text files.
  25
  26 Note that these functions either encapsulate the python programming
  27 interface of GEOM core (the CORBA or SWIG interfaces for example) or
  28 extend existing utilities as the ``geompy.py`` module.
  29
  30 The functions are distributed in the python package
  31 ``salome.geom``. For example, the usage of the visualization of
  32 structural elements can be appreciated with this set of instructions:
  33
  34 \code
  35
  36    from salome.geom.structelem import TEST_StructuralElement
  37    TEST_StructuralElement()
  38 \endcode
  39
  40 This creates the geometrical objects displayed in the study below:
  41
  42 \image html salome-geom-structuralelements.png "Example of Geometry created from structural elements"
  43
  44 */