/**
@mainpage
- <A HREF="../HYDRO_tutorial/index.html">A Tutorial on SALOME HYDRO </A>
+ <b>The HYDRO documentation is divided in two parts:</b>
+ - <b>the reference documentation below </b>
+ - <b>a Tutorial in French:</b> <A HREF="../HYDRO_tutorial/index.html">Here </A>
+
The HYDRO GUI project has been developed for a hydrodynamic laboratory in the EDF R&D company
in the domain of the landscape modelling (construction of channels, dams, changing the course of the rivers etc).
# along with SALOME HYDRO module. If not, see <http://www.gnu.org/licenses/>.
SET(RSTFILES
+ casCalcul.rst
+ depouillementCalcul.rst
+ geometrie.rst
+ import.rst
+ importBathy.rst
index.rst
+ interpolationZ.rst
+ lancementCalcul.rst
+ maillage.rst
+ miseEnDonneesTelemac.rst
+ objetsArtificiels.rst
+ objetsNaturels.rst
+ polylignes.rst
preliminaires.rst
- import.rst
+ streams.rst
)
SET(SPHINXOPTS )
--- /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/>.
+
+#########################################
+Constitution du cas de calcul
+#########################################
+
+blabla.
\ 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/>.
+
+#########################################
+Dépouillement du calcul TELEMAC
+#########################################
+
+blabla.
\ 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/>.
+
+#########################################
+Etape géometrique
+#########################################
+
+blabla.
\ No newline at end of file
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|.
+Pour activer le module HYDRO, il faut le sélectionner dans la liste défilante des modules
+ou cliquer sur son icône dans le bandeau : |Hydro_module_button|.
|Hydro_module_launch|
.. 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
+Pour importer une image, on utilise le menu contextuel de la rubrique *IMAGES* dans l'arbre de
l'étude SALOME:
|import_image|
<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
+dont on connaît les coordonnées 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 :
+Voici les deux points particuliers dont on a préalablement repéré les coordonnées avec Géoportail :
|selection_A| coordonnées (471562, 6367750): un point en dessous à gauche de la marque *92*.
|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.
+la deuxiè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
+Il faut s'assurer que l'icône "oeil" à gauche du nom de l'image dans l'arbre est bien active, 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
+ Le zoom peut être centré sur la position de la souris, ou au centre de l'image. 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
+ * **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
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
+Import d'une deuxième image, géoréférencée à partir la première
================================================================
La deuxième image est au même endroit que la première ::
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.
+On sélectionne 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 :
--- /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 de bathymétrie
+#########################################
+
+blabla.
\ No newline at end of file
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.
+de fleuve. L'exemple est tiré d'un cas réel pour lequel beaucoup de données sont disponibles.
.. toctree::
:maxdepth: 2
preliminaires.rst
import.rst
+ importBathy.rst
+ polylignes.rst
+ objetsNaturels.rst
+ streams.rst
+ objetsArtificiels.rst
+ casCalcul.rst
+ geometrie.rst
+ maillage.rst
+ interpolationZ.rst
+ miseEnDonneesTelemac.rst
+ lancementCalcul.rst
+ depouillementCalcul.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/>.
+
+#########################################
+Interpolation en Z
+#########################################
+
+blabla.
\ 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/>.
+
+#########################################
+Lancement du calcul TELEMAC
+#########################################
+
+blabla.
\ 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/>.
+
+#########################################
+Création du maillage
+#########################################
+
+blabla.
\ 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/>.
+
+#########################################
+Mise en données TELEMAC
+#########################################
+
+blabla.
\ 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/>.
+
+#########################################
+Objets Artificiels
+#########################################
+
+blabla.
\ 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/>.
+
+#########################################
+Objets Naturels
+#########################################
+
+blabla.
\ 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/>.
+
+#########################################
+Création de polylignes
+#########################################
+
+blabla.
\ No newline at end of file
* **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).
+ métropolitain sont par exemple 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
--- /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/>.
+
+#########################################
+Streams
+#########################################
+
+blabla.
\ No newline at end of file
