doc/salome/tutorial/index.rst

   1 ..
   2    Copyright (C) 2015-2016 EDF
   3
   4    This file is part of SALOME HYDRO module.
   5
   6    SALOME HYDRO module is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    SALOME HYDRO module is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
  18
  19
  20 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  21 Tutoriel SALOME HYDRO
  22 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  23
  24 .. |Hydro_module_button| image:: /_static/HYDRO.png
  25    :align: middle
  26    :width: 16pt
  27    :height: 16pt
  28
  29 .. |hydrosolver_module_button| image:: /_static/HYDROSolver.png
  30    :align: middle
  31    :width: 16pt
  32    :height: 16pt
  33
  34 SALOME-HYDRO est une plateforme métier dédiée aux études d'hydraulique à surface
  35 libre, avec les codes TELEMAC et MASCARET. La plateforme s'appuie sur les modules
  36 génériques de SALOME (géométrie, maillage, supervision de calculs, post traitement...)
  37 auxquels ont été ajoutés deux modules spécifiques du métier :
  38
  39   * HYDRO |Hydro_module_button| : acquisition des données de terrain (contours, bathymétrie...),
  40     construction de la géométrie du cas de calcul, identification des zones de
  41     condition limite...
  42
  43   * HYDROSolver |hydrosolver_module_button| : définition des paramètres physiques et
  44     numériques du cas de calcul, pilotage du calcul.
  45
  46 Le tutoriel traite l'ensemble des étapes d'une étude d'inondation liée à une crue
  47 de fleuve. L'exemple est tiré d'un cas réel pour lequel beaucoup de données sont disponibles.
  48
  49 .. _ref_installationLancementSalome:
  50
  51 ###################################
  52 Introduction à SALOME
  53 ###################################
  54
  55 Dans cette partie, on rappelle comment installer et exécuter SALOME.
  56
  57 .. toctree::
  58    :numbered:
  59    :maxdepth: 3
  60
  61    installationLancementSalome.rst
  62
  63 .. _ref_notionsPrealables:
  64
  65 ###################################
  66 Quelques notions préalables
  67 ###################################
  68
  69 On décrit ici les différentes étapes d'une étude SALOME-HYDRO, en introduisant les concepts nécessaires.
  70 Cette partie contient également une série de recommandations et de pièges à éviter.
  71
  72 L'exercice décrit plus bas permet de découvrir ces concepts par la manipulation.
  73
  74 .. toctree::
  75    :numbered:
  76    :maxdepth: 3
  77
  78    preliminaires.rst
  79    piegesAEviter.rst
  80    donneesPrealables.rst
  81
  82 .. _ref_exempleInondation:
  83
  84 ###################################
  85 Un exemple simple d'inondation
  86 ###################################
  87
  88 Cet exercice couvre complètement une étude d'inondation sur un problème simple.
  89
  90 .. toctree::
  91    :numbered:
  92    :maxdepth: 3
  93
  94    import.rst
  95    importBathy.rst
  96    polylignes.rst
  97    objetsNaturels.rst
  98    casCalcul.rst
  99    geometrie.rst
 100    maillage.rst
 101    interpolationZ.rst
 102    miseEnDonneesTelemac.rst
 103    lancementCalcul.rst
 104    depouillementCalcul.rst
 105
 106 .. _ref_casParticuliers:
 107
 108 ###################################
 109 Des cas particuliers
 110 ###################################
 111
 112 On introduit ici quelques concepts non abordés dans l'exemple simple précédent.
 113
 114 .. toctree::
 115    :numbered:
 116    :maxdepth: 3
 117
 118    streams.rst
 119    objetsArtificiels.rst
 120    manipsPolys.rst
 121    landCoverMap.rst
 122
 123 .. _ref_formatsSpecs:
 124
 125 ###################################
 126 Formats et specifications
 127 ###################################
 128
 129 On introduit ici quelques formats d'import-export.
 130 La documentation du format SinusX en français correspond à l'usage d'origine du format et donne une transposition pour l'usage SALOME,
 131 **La documentation du format SinusX en anglais donne la spécification précise du format SinusX dans SALOME HYDRO.
 132 C'est cette dernière documentation qui constitue la référence pour SALOME HYDRO.**
 133
 134 .. toctree::
 135    :numbered:
 136    :maxdepth: 3
 137
 138    format_sinusx.rst
 139    sinusX_Format.rst