]> SALOME platform Git repositories - modules/geom.git/commitdiff
Salome HOME
Updating documentation to integrate the geom python package documentation
authorboulant <boulant>
Thu, 29 Jul 2010 12:41:31 +0000 (12:41 +0000)
committerboulant <boulant>
Thu, 29 Jul 2010 12:41:31 +0000 (12:41 +0000)
doc/salome/gui/GEOM/images/salome-geom-structuralelements.png [new file with mode: 0644]
doc/salome/gui/GEOM/input/geompypkg.doc [new file with mode: 0644]
doc/salome/gui/GEOM/input/index.doc

diff --git a/doc/salome/gui/GEOM/images/salome-geom-structuralelements.png b/doc/salome/gui/GEOM/images/salome-geom-structuralelements.png
new file mode 100644 (file)
index 0000000..6ed41b1
Binary files /dev/null and b/doc/salome/gui/GEOM/images/salome-geom-structuralelements.png differ
diff --git a/doc/salome/gui/GEOM/input/geompypkg.doc b/doc/salome/gui/GEOM/input/geompypkg.doc
new file mode 100644 (file)
index 0000000..3b69039
--- /dev/null
@@ -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"
+
+*/
index d28e8c343b3fe16997bcc8b1ca5acbb5713137b9..efbf665b4a46b589066bf1020682d271bfaa29c9 100644 (file)
@@ -23,6 +23,9 @@ various algorithms;</li>
 Almost all geometry module functionalities are accessible via
 \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"