Salome HOME
Merge branch 'V9_7_BR'
[tools/documentation.git] / no_main / tui.rst
diff --git a/no_main/tui.rst b/no_main/tui.rst
new file mode 100644 (file)
index 0000000..f32409c
--- /dev/null
@@ -0,0 +1,68 @@
+.. _tui:
+
+.. figure:: /images/head.png
+   :align: center
+
+Developer's Documentation
+=========================
+
+This chapter contains different reference manuals and other documents which can be
+helpful for the developers who wants to customize the **SALOME platform** or develop
+new features, modules, plugins, etc.
+
+.. |pdf| image:: /images/pdf.png
+   :height: 16px
+.. |warn| image:: /images/warn.png
+   :height: 16px
+.. |fr| image:: /images/fr.png
+   :height: 16px
+
+.. table::
+
+   +--------+----------------------------+
+   | Legend                              |
+   +========+============================+
+   | |warn| | Document is not up to date |
+   +--------+----------------------------+
+   | |fr|   | Document in French         |
+   +--------+----------------------------+
+   | |pdf|  | Document in PDF format     |
+   +--------+----------------------------+
+
+Architecture
+~~~~~~~~~~~~
+
+* |pdf| `SALOME GUI Architecture <../extra/SALOME_GUI_Architecture.pdf>`__ (PDF, 1 MB) |warn|
+
+Module Development
+~~~~~~~~~~~~~~~~~~
+
+* The **SALOME Tutorial** provides an introduction to the development of new modules
+  and integrating them to the SALOME platform, as well as new applications based on SALOME.
+  The tutorial can be downloaded from `SALOME site <https://www.salome-platform.org/downloads>`__.
+
+* |pdf| `Implement Dump Python <../extra/DumpPython_Extension.pdf>`__ (PDF, 67 KB)
+
+Mesh
+~~~~
+
+* |pdf| `Use of SMDS API <../extra/SALOME_4.1.2_SMDS_reference_guide.pdf>`__ (PDF, 416 KB) |warn|
+* |pdf| `Integration of new meshing algorithm as plug-in to SALOME Mesh module <../extra/SALOME_Mesh_Plugins.pdf>`__ (PDF, 91 KB)
+
+Code Coupling
+~~~~~~~~~~~~~
+
+* |pdf| `Normalisation des maillages et des champs pour le couplage <../extra/Normalisation_pour_le_couplage_de_codes.pdf>`__ (PDF, 1 MB) |fr|
+* |pdf| `Documentation of the Interface for Code Coupling / ICoCo <../extra/Interface_for_Code_Coupling.pdf>`__ (PDF, 1.6 MB) |fr|
+* |pdf| `Le couplage de codes paralleles dans la plateforme SALOME <../extra/Couplage_de_codes_paralleles.pdf>`__ (PDF, 589 KB) |fr|
+* |pdf| `Démonstrateur couplage fluide structure EDF <../extra/Demonstrateur_couplage_fluide_structure_EDF.pdf>`__ (PDF, 1.2 MB) |fr|
+
+Installation procedure
+~~~~~~~~~~~~~~~~~~~~~~
+
+* `Build procedure <../dev/cmake/html/index.html>`__ (CMake)
+
+Development
+~~~~~~~~~~~
+
+* `Contributing to the SALOME project with Git <../dev/git/html/Git_Simple_Write_Procedure.html>`__