Salome HOME
Merge branch 'BR_H2018_DRAFT' into BR_2018_V8_5
[modules/hydro.git] / doc / salome / tutorial / index.rst
index db7b9183873c5d7959fd6f68859d8a5c3d3c0eef..e6fc66c8e49fd9bd4fce55677461100010c25362 100644 (file)
@@ -31,7 +31,7 @@ Tutoriel SALOME HYDRO
    :width: 16pt
    :height: 16pt
 
-SALOME HYDRO est une plateforme métier dédiée aux études d'hydraulique à surface
+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 : 
@@ -39,22 +39,78 @@ 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
+    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::
-   :maxdepth: 2
+   :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.
+
+L'exercice décrit plus bas permet de découvrir ces concepts par la manipulation. 
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
 
    preliminaires.rst
+   piegesAEviter.rst
+   donneesPrealables.rst
+
+
+.. _ref_outilsComplementaires:
+
+###################################
+Des outils complémentaires à SALOME
+###################################
+
+Les outils qgis et CloudCompare sont fournis à coté de SALOME-HYDRO.
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+  introQgis.rst
+  introCloudCompare.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
-   streams.rst
-   objetsArtificiels.rst
    casCalcul.rst
    geometrie.rst
    maillage.rst
@@ -62,5 +118,38 @@ de fleuve. L'exemple est tiré d'un cas réel pour lequel beaucoup de données s
    miseEnDonneesTelemac.rst
    lancementCalcul.rst
    depouillementCalcul.rst
-   
-   
\ No newline at end of file
+
+.. _ref_casParticuliers:
+
+###################################
+Des cas particuliers
+###################################
+
+On introduit ici quelques concepts non abordés dans l'exemple simple précédent.
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+   streams.rst
+   objetsArtificiels.rst
+   manipsPolys.rst
+   landCoverMap.rst
+
+.. _ref_formatsSpecs:
+
+###################################
+Formats et specifications
+###################################
+
+On introduit ici quelques formats d'import-export.
+La documentation du format SinusX en français correspond à l'usage d'origine du format et donne une transposition pour l'usage SALOME, 
+**La documentation du format SinusX en anglais donne la spécification précise du format SinusX dans SALOME HYDRO.
+C'est cette dernière documentation qui constitue la référence pour SALOME HYDRO.**
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+   format_sinusx.rst
+   sinusX_Format.rst