main/tui.rst

   1 .. _tui:
   2
   3 .. figure:: /images/head.png
   4    :align: center
   5
   6 Developer's Documentation
   7 =========================
   8
   9 This chapter contains different reference manuals and other documents which can be
  10 helpful for the developers who wants to customize the **SALOME platform** or develop
  11 new features, modules, plugins, etc.
  12
  13 Modules documentation
  14 ---------------------
  15
  16 * `KERNEL module <../tui/KERNEL/index.html>`__
  17
  18 *This is the developer reference manual for the SALOME KERNEL module. It provides a general
  19 description of the main services implemented within the KERNEL module.*
  20
  21 * `GUI module <../tui/GUI/index.html>`__
  22
  23 *This is the developer reference manual for the SALOME GUI module. It provides a description
  24 of the basic functionalities available in the GUI module.*
  25
  26 * `Shaper module <../tui/SHAPER/index.html>`__
  27
  28 *This section contains developer reference manual for the SALOME Shaper module. Shaper is a
  29 CAD modeler which came as a replacement for the former Geometry module.*
  30
  31 * `Geometry module <../tui/GEOM/index.html>`__
  32
  33 This section contains developer reference manual for the SALOME Geometry module, the legacy
  34 CAD modeler of the SALOME platform.*
  35
  36 * `Mesh module <../tui/SMESH/index.html>`__
  37
  38 *This is the developer reference manual for the SALOME Mesh module. This module can be used
  39 for generating of the meshes from the CAD model prepared in Geometry or Shaper.*
  40
  41 * `YACS module  <../tui/YACS/index.html>`__
  42
  43 *This section contains developer reference manual for the SALOME YACS module.*
  44
  45 * `Fields module  <../dev/FIELDS/index.html>`__
  46
  47 *This section contains developer reference manual for the SALOME Fields module formely known
  48 as Med module.*
  49
  50 * `ParaVis module  <../dev/PARAVIS/index.html>`__
  51
  52 *This section contains developer reference manual for the SALOME ParaVis module.*
  53
  54 Guides
  55 ------
  56
  57 .. |pdf| image:: /images/pdf.png
  58    :height: 16px
  59 .. |warn| image:: /images/warn.png
  60    :height: 16px
  61 .. |fr| image:: /images/fr.png
  62    :height: 16px
  63
  64 .. table::
  65
  66    +--------+----------------------------+
  67    | Legend                              |
  68    +========+============================+
  69    | |warn| | Document is not up to date |
  70    +--------+----------------------------+
  71    | |fr|   | Document in French         |
  72    +--------+----------------------------+
  73    | |pdf|  | Document in PDF format     |
  74    +--------+----------------------------+
  75
  76 Architecture
  77 ~~~~~~~~~~~~
  78
  79 * |pdf| `SALOME GUI Architecture <../extra/SALOME_GUI_Architecture.pdf>`__ (PDF, 1 MB) |warn|
  80
  81 Module Development
  82 ~~~~~~~~~~~~~~~~~~
  83
  84 * The **SALOME Tutorial** provides an introduction to the development of new modules
  85   and integrating them to the SALOME platform, as well as new applications based on SALOME.
  86   The tutorial can be downloaded from `SALOME site <https://www.salome-platform.org/downloads>`__.
  87
  88 * |pdf| `Implement Dump Python <../extra/DumpPython_Extension.pdf>`__ (PDF, 67 KB)
  89
  90 Mesh
  91 ~~~~
  92
  93 * |pdf| `Use of SMDS API <../extra/SALOME_4.1.2_SMDS_reference_guide.pdf>`__ (PDF, 416 KB) |warn|
  94 * |pdf| `Integration of new meshing algorithm as plug-in to SALOME Mesh module <../extra/SALOME_Mesh_Plugins.pdf>`__ (PDF, 91 KB)
  95
  96 Code Coupling
  97 ~~~~~~~~~~~~~
  98
  99 * |pdf| `Normalisation des maillages et des champs pour le couplage <../extra/Normalisation_pour_le_couplage_de_codes.pdf>`__ (PDF, 1 MB) |fr|
 100 * |pdf| `Documentation of the Interface for Code Coupling / ICoCo <../extra/Interface_for_Code_Coupling.pdf>`__ (PDF, 1.6 MB) |fr|
 101 * |pdf| `Le couplage de codes paralleles dans la plateforme SALOME <../extra/Couplage_de_codes_paralleles.pdf>`__ (PDF, 589 KB) |fr|
 102 * |pdf| `Démonstrateur couplage fluide structure EDF <../extra/Demonstrateur_couplage_fluide_structure_EDF.pdf>`__ (PDF, 1.2 MB) |fr|
 103
 104 Installation procedure
 105 ~~~~~~~~~~~~~~~~~~~~~~
 106
 107 * `Build procedure <../dev/cmake/html/index.html>`__ (CMake)
 108
 109 Development
 110 ~~~~~~~~~~~
 111
 112 * `Contributing to the SALOME project with Git <../dev/git/html/Git_Simple_Write_Procedure.html>`__