--- /dev/null
+..
+ Copyright (C) 2015-2016 EDF
+
+ This file is part of SALOME HYDRO module.
+
+ SALOME HYDRO module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME HYDRO module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with SALOME HYDRO module. If not, see <http://www.gnu.org/licenses/>.
+
+#########################################
+Import des images et fonds de plan
+#########################################
+
+.. |Hydro_module_button| image:: /_static/HYDRO.png
+ :align: middle
+ :width: 16pt
+ :height: 16pt
+
+.. |Hydro_module_launch| image:: /_static/LaunchHYDRO.png
+ :align: middle
+
+.. |import_image| image:: /_static/importImage.png
+ :align: middle
+
+.. |import_image2| image:: /_static/importImage2.png
+ :align: middle
+
+.. |selection_A| image:: /_static/selectionA.png
+ :align: middle
+
+.. |selection_B| image:: /_static/selectionB.png
+ :align: middle
+
+.. |selection_B2| image:: /_static/selectionB2.png
+ :align: middle
+
+.. |fit_all| image:: /_static/fitall.png
+ :align: middle
+
+.. |import_image_B| image:: /_static/importImageB.png
+ :align: middle
+
+.. |deux_images| image:: /_static/deuxImages.png
+ :align: middle
+
+.. |zoom_style| image:: /_static/zoomStyle.png
+ :align: middle
+
+Chargement du module HYDRO
+==========================
+Pour actver le module HYDRO, il faut le selectionner dans la liste défilante des modules
+ou cliquer sur son icone dans le bandeau : |Hydro_module_button|.
+
+ |Hydro_module_launch|
+
+
+Import et géoréférencement d'une première image
+===============================================
+
+Pour construire le contour de la rivière, on va importer plusieurs images.
+Ici il s'agit de cartes que l'on peut télécharger à partir de sites comme Géoportail_
+ou le site de l'IGN. Géoportail offre la possibilité de trouver les coordonnées de points dans
+une image, nécessaires au géoréférencement.
+
+.. Géoportail_: http://www.geoportail.gouv.fr/accueil
+
+Pour importer une image, on utilise le menu contextuel de la rubrique *IMGAGES* dans l'arbre de
+l'étude SALOME:
+
+ |import_image|
+
+La première image se trouve dans le répertoire d'installation de l'application SALOME HYDRO ::
+
+ <appli_xxx>/bin/salome/test/HYDRO/garonne_ign_01.png
+
+L'image est affichée, avec deux points *A* et *B* qui vont être repositionnés à des emplacements
+dont on connait la position dans le repère Lambert 93, choisis assez éloignés l'un de l'autre
+pour garder une bonne précision.
+
+ |import_image2|
+
+Voici les deux points particuliers dont on a prélablement repéré les coordonnées avec Géoportail :
+
+ |selection_A| coordonnées (471562, 6367750): un point en dessous à gauche de la marque *92*.
+
+ |selection_B| coordonnées (489400, 6377020): le centre de la croix à coté de *Hautevignes*.
+
+ * **remarque** : Pour contrôler le zoom sur la carte, on utilise la touche <Ctrl> avec le bouton droit
+ de la souris. Pour se déplacer sur la carte, il faut utiliser la touche <Ctrl> avec le bouton du milieu
+ de la souris.
+
+On sélectionne successivement le point A, puis le point B, en utilisant les boutons
+*Activate point A selection* puis *Activate point B selection*.
+Après avoir sélectionné les deux points, le dialogue de géoréférencement ressemble à ceci :
+
+ |selection_B2|
+
+Pour les coordonnées x,y de chaque point, la première colonne donne les coordonnées du pixel de l'image,
+lacdeuxième colonne donne les coordonnées géographiques.
+
+On valide le géoréférencement avec le bouton *Apply and Close*.
+Il faut s'assurer que l'oeil à gauche du nom de l'image dans l'arbre est bien actif, et recentrer l'image
+à l'aide du bouton *fit all* : |fit_all|.
+
+L'image obtenue est légèrement inclinée vers la droite.
+
+ * **remarque** : dans cette vue, le zoom peut se faire à l'aide de la molette de la souris.
+ Le zoom peut être centré sur la position de la souris. C'est une option accessible dans le menu
+ *File/préférences* sous la rubrique *SALOME*, onglet *3D viewer*, *zooming style* :
+
+ |zoom_style|
+
+Quand on promène la souris sur la carte, les coordonnées du curseur s'affichent dans la barre d'état
+en bas à gauche de l'application.
+
+ * **remarque** : il faut prendre l'habitude de sauver l'étude en cours régulièrement
+ (menu *File/Save* ou *File/Save as*). Il est également conseillé de sauvegarder les différentes
+ étapes de l'étude dans des fichiers différents : *il est arrivé, dans certaines circonstances difficiles
+ à reproduire, que l'étude soit sauvée de manière incomplète.* Les cas où ce problème est survenu
+ correspondent à des rechargements d'études comprenant des données de plusieurs modules, et pour lesquels
+ le module HYDRO n'a pas été activé avant la sauvegarde. On se prémunit contre se risque de sauvegarde
+ incomplète en activant le module HYDRO avant de sauvegarder l'étude.
+
+Import d'une deuxième image, géorférérencée à partir la première
+================================================================
+
+La deuxième image est au même endroit que la première ::
+
+ <appli_xxx>/bin/salome/test/HYDRO/garonne_ign_02.png
+
+Pour la géoréférencer, on utilise l'option *choose points on the reference image* du dialogue.
+Après avoir sélectionné la première image comme référence, on voit les deux images l'une en dessus de l'autre.
+On selectionne d'abord un point A au même emplacement sur les deux images, puis un point B.
+Il faut prendre deux points les plus éloignés possible, et zoomer suffisamment pour être précis.
+Le dialogue ressemble alors à ceci :
+
+ |import_image_B|
+
+Après avoir validé le dialogue, puis affiché les deux images et recentré la vue, on obtient :
+
+ |deux_images|
+
+Définition d'un repère local
+===========================================
+
+Le repère local permet la manipulation de petits nombres. **Le changement de repère améliore
+beaucoup la précision des étapes de géométrie, de maillage et de calcul**. Notamment, le fait
+de garder des grands nombres peut rendre impossible l'obtention d'un maillage de bonne qualité.
+
+Dans le menu *HYDRO/Change Local CS*, on saisit les coordonnées de la nouvelle origine.
+
+Pour notre exemple, on prend pour origine le point (430 000, 6 350 000) situé
+au sud ouest de notre domaine d'étude.
+
+Après avoir validé le changement de repère, on constate que les coordonnées du curseur
+qui s'affichent dans la barre d'état en bas à gauche de l'application sont fournies dans
+les deux repères (local et global).
+
+ * **remarque** : ce changement de repère peut être fait plusieurs fois, à différents moments
+ de l'étude, car tout ce qui a déjà été importé est transposé par l'application,
+ mais il est préférable de le faire assez tôt pour minimiser les risques d'erreur ou d'incohérence,
+ et, en tous cas, avant d'exporter des éléments du module HYDRO, notamment la géométrie de calcul.
+ **Il est recommandé de fixer le repère local tôt dans l'étude, dès que l'étendue du domaine de calcul
+ est connue**.
+
+Dump Python
+=============
+
+Toutes les opérations effectuées à l'interface graphique ont leur équivalent en script Python.
+On peut faire un dump de l'étude dans un script avec le menu *File/Dump Study*.
+Le script Python obtenu permet, en partant d'une étude SALOME vierge, de reconstruire les données
+de l'étude. ce script est, bien sûr, éditable.
+
+On peut faire le dump après la définition du repère local, et comparer le fichier obtenu avec ::
+
+ <appli_xxx>/bin/salome/test/HYDRO/h003_changeLCS.py
+
+On pourra vérifier la bonne exécution du dump en repartant d'une étude vierge (redémarrer SALOME,
+*new document*, ou seulement *new document*), puis menu *File/Load Script* et activation du module HYDRO.
+
..
- 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éél pour lequel beaucoup de données sont disponibles.
+
.. toctree::
:maxdepth: 2
+ preliminaires.rst
+ import.rst
+
\ No newline at end of file
--- /dev/null
+..
+ Copyright (C) 2015-2016 EDF
+
+ This file is part of SALOME HYDRO module.
+
+ SALOME HYDRO module is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ SALOME HYDRO module is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with SALOME HYDRO module. If not, see <http://www.gnu.org/licenses/>.
+
+#########################################
+Notions préliminaires
+#########################################
+
+ * **Géoréférencement** : Le système de projection à utiliser dépend de
+ la localisation géographique de l'étude et doit être choisi et noté
+ pour faciliter la reprise de l'étude. En France métropolitaine, la
+ projection de référence est Lambert 93.
+
+ * **Repère Local** : Les coordonnées planes, **toujours exprimées en mètres**,
+ dans la projection utilisée correspondent souvent à des grands nombres.
+ Par exemple, les coordonnées en Lambert 93 d'un point du territoire
+ métropolitain sont de l'ordre de (400 000, 6 500 000).
+ Le repère local consiste en un simple décalage de l'origine, permettant
+ de manipuler de plus petits nombres.
+ Pour améliorer la précision numérique dans les différentes étapes de
+ l'étude (géométrie, maillage, calcul...),
+ **il est très fortement recommandé de prendre un repère local**.
+
+
