..
- Copyright (C) 2012-2013 EDF
+ Copyright (C) 2015-2016 EDF
This file is part of SALOME HYDRO module.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-Hydro module documentation
+Tutoriel SALOME HYDRO
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
.. |Hydro_module_button| image:: /_static/HYDRO.png
:width: 16pt
:height: 16pt
-This documentation covers the usage of Hydro module in Salome. This module
-aims at providing services for the usage of Telemac and Mascaret codes. To
-activate this module, click on the |Hydro_module_button| button in the
-toolbar or select "Hydro" item in the "SALOME" menu. The first part of
-this guide addresses simple use cases (how to run the codes from Salome-Hydro
-platform) while the second part presents more advanced topics (code coupling).
+.. |hydrosolver_module_button| image:: /_static/HYDROSolver.png
+ :align: middle
+ :width: 16pt
+ :height: 16pt
+
+SALOME HYDRO est une plateforme métier dédiée aux études d'hydraulique à surface
+libre, avec les codes TELEMAC et MASCARET. La plateforme s'appuie sur les modules
+génériques de SALOME (géométrie, maillage, supervision de calculs, post traitement...)
+auxquels ont été ajoutés deux modules spécifiques du métier :
+
+ * HYDRO |Hydro_module_button| : acquisition des données de terrain (contours, bathymétrie...),
+ construction de la géométrie du cas de calcul, identification des zones de
+ condition limite...
+
+ * HYDROSolver |hydrosolver_module_button| : définition des paramètres physiques et
+ numériques du cas de calcul, pilotage du calcul
+
+Le tutoriel traite l'ensemble des étapes d'une étude d'inondation liée à une crue
+de fleuve. L'exemple est tiré d'un cas réel pour lequel beaucoup de données sont disponibles.
+
+.. _ref_installationLancementSalome:
+
+###################################
+Introduction à SALOME
+###################################
+
+Dans cette partie, on rappelle comment installer et exécuter SALOME.
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ installationLancementSalome.rst
+
+.. _ref_notionsPrealables:
+
+###################################
+Quelques notions préalables
+###################################
+
+On décrit ici les différentes étapes d'une étude SALOME-HYDRO, en introduisant les concepts nécessaires.
+Cette partie contient également une série de recommandations et de pièges à éviter.
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ preliminaires.rst
+ piegesAEviter.rst
+ donneesPrealables.rst
+
+.. _ref_exempleInondation:
+
+###################################
+Un exemple simple d'inondation
+###################################
+
+Cet exercice couvre complètement une étude d'inondation sur un problème simple.
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ import.rst
+ importBathy.rst
+ polylignes.rst
+ objetsNaturels.rst
+ casCalcul.rst
+ geometrie.rst
+ maillage.rst
+ interpolationZ.rst
+ miseEnDonneesTelemac.rst
+ lancementCalcul.rst
+ depouillementCalcul.rst
+
+.. _ref_casParticuliers:
+
+###################################
+Des cas particuliers
+###################################
+
+On introduit ici quelques concepts non abordés dans l'exemple simple précédent.
.. toctree::
- :maxdepth: 2
+ :numbered:
+ :maxdepth: 3
+ streams.rst
+ objetsArtificiels.rst
+ landCoverMap.rst
+
\ No newline at end of file
