mirror of
https://git.salome-platform.org/gitpub/modules/geom.git
synced 2025-01-13 10:10:34 +05:00
Updating documentation to integrate the geom python package documentation
This commit is contained in:
parent
f53c1745f1
commit
1efcbd196a
BIN
doc/salome/gui/GEOM/images/salome-geom-structuralelements.png
Normal file
BIN
doc/salome/gui/GEOM/images/salome-geom-structuralelements.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 168 KiB |
35
doc/salome/gui/GEOM/input/geompypkg.doc
Normal file
35
doc/salome/gui/GEOM/input/geompypkg.doc
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
/*!
|
||||||
|
|
||||||
|
\page geompypkg_page Programming Interface of GEOM python package
|
||||||
|
|
||||||
|
The GEOM python package essentially contains:
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>The visualization of structural elements: a function to create
|
||||||
|
geometrical 3D representations of mechanical models called
|
||||||
|
"structural elements".
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
For details, you should refer to the complete
|
||||||
|
<a href="../../docutils/GEOM/index.html"> documentation of the GEOM
|
||||||
|
python packages</a>, writen using sphinx.
|
||||||
|
|
||||||
|
Note that these functions either encapsulate the python programming
|
||||||
|
interface of GEOM core (the CORBA or SWIG interfaces for example) or
|
||||||
|
extend existing utilities as the ``geompy.py`` module.
|
||||||
|
|
||||||
|
The functions are distributed in the python package
|
||||||
|
``salome.geom``. For example, the usage of the visualization of
|
||||||
|
structural elements can be appreciated with this set of instructions:
|
||||||
|
|
||||||
|
\code
|
||||||
|
|
||||||
|
from salome.geom.structelem import TEST_StructuralElement
|
||||||
|
TEST_StructuralElement()
|
||||||
|
\endcode
|
||||||
|
|
||||||
|
This creates the geometrical objects displayed in the study below:
|
||||||
|
|
||||||
|
\image html salome-geom-structuralelements.png "Example of Geometry created from structural elements"
|
||||||
|
|
||||||
|
*/
|
@ -23,6 +23,9 @@ various algorithms;</li>
|
|||||||
Almost all geometry module functionalities are accessible via
|
Almost all geometry module functionalities are accessible via
|
||||||
\subpage geompy_page "Geometry module Python Interface"
|
\subpage geompy_page "Geometry module Python Interface"
|
||||||
|
|
||||||
|
\n Have a look also at the
|
||||||
|
<a href="../../docutils/GEOM/index.html"> documentation of the GEOM python packages</a>
|
||||||
|
|
||||||
\image html image3.png "Example of Geometry module usage for engineering tasks"
|
\image html image3.png "Example of Geometry module usage for engineering tasks"
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user