Salome HOME
Corrections of examples path after install with scbi
[modules/hydro.git] / doc / salome / tutorial / english / english_import.rst
index c16428968c2fedc58675008386150a169befa82f..03d1b5ca400f796d256223bac4a66eecd46cae49 100644 (file)
    along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
 
 #########################################
-Import des images et fonds de plan
+Image and map background import
 #########################################
 
-.. |Hydro_module_button| image:: /../_static/HYDRO.png
+.. |Hydro_module_button| image:: ../_static/HYDRO.png
    :align: middle
    :width: 16pt
    :height: 16pt
 
-.. |Hydro_module_launch| image:: /../_static/LaunchHYDRO.png
+.. |Hydro_module_launch| image:: ../_static/LaunchHYDRO.png
    :align: middle
 
-.. |import_image| image:: /../_static/importImage.png
+.. |import_image| image:: ../_static/importImage.png
    :align: middle
 
-.. |import_image2| image:: /../_static/importImage2.png
+.. |import_image2| image:: ../_static/importImage2.png
    :align: middle
 
-.. |selection_A| image:: /../_static/selectionA.png
+.. |selection_A| image:: ../_static/selectionA.png
    :align: middle
 
-.. |selection_B| image:: /../_static/selectionB.png
+.. |selection_B| image:: ../_static/selectionB.png
    :align: middle
 
-.. |selection_B2| image:: /../_static/selectionB2.png
+.. |selection_B2| image:: ../_static/selectionB2.png
    :align: middle
 
-.. |fit_all| image:: /../_static/fitall.png
+.. |fit_all| image:: ../_static/fitall.png
    :align: middle
 
-.. |import_image_B| image:: /../_static/importImageB.png
+.. |import_image_B| image:: ../_static/importImageB.png
    :align: middle
 
-.. |deux_images| image:: /../_static/deuxImages.png
+.. |deux_images| image:: ../_static/deuxImages.png
    :align: middle
 
-.. |zoom_style| image:: /../_static/zoomStyle.png
+.. |zoom_style| image:: ../_static/zoomStyle.png
    :align: middle
 
-Chargement du module HYDRO
-==========================
+Loading the HYDRO module
+========================
 
-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|.
+To activate the HYDRO module, it should be selected in the module scrolling list
+or its icon clicked on in the ribbon: |Hydro_module_button|.
 
   |Hydro_module_launch|
 
 
-Import et géoréférencement d'une première image
-===============================================
+Importing and georeferencing a first image
+==========================================
 
-Pour construire le contour de la rivière, nous allons 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. 
+Several images need to be imported in order to construct the contour of the river.
+In this case, they are maps that can be downloaded from sites such as `Géoportail`_ or the IGN website.
+Géoportail provides the means to find point coordinates in an image, needed for georeferencing.
 
 .. _Géoportail: http://www.geoportail.gouv.fr/accueil
 
-Pour importer une image, nous utilisons le menu contextuel (clic droit) de la rubrique *IMAGES* dans l'arbre de
-l'étude SALOME: 
+To import an image, open the pop-up menu (right click) in the SALOME HYDRO study tree *IMAGES* folder:
 
   |import_image|
-  
-La première image se trouve dans le répertoire d'installation de l'application SALOME HYDRO ::
+
+To import an image, open the pop-up menu (right click) in the SALOME HYDRO study tree IMAGES folder::
 
   <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 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.
+The image is displayed with two points, *A*and *B*, which will be repositioned at locations
+whose coordinates in the Lambert 93 system are known, selected far enough apart to maintain
+a good level of precision.
 
   |import_image2|
-Voici les deux points particuliers dont on a préalablement repéré les coordonnées avec Géoportail :
+
+The two specific points for which the coordinates were previously located with Géoportail are shown below:
 
   |selection_A|
 
-coordonnées (471562, 6367750): un point en dessous à gauche de la marque *92*.
+One point below and to the left of the figure *92*:  coordinates (471562, 6367750).
 
   |selection_B|
 
-coordonnées (489400, 6377020): le centre de la croix à coté de *Hautevignes*.
+The second at the centre of the cross next to *Hautevignes*: coordinates (489400, 6377020).
 
- * **remarque** : Pour contrôler le zoom sur la carte, on utilise la touche <Ctrl> avec le bouton gauche 
-   de la souris. Pour se déplacer sur la carte, il faut utiliser la touche <Ctrl> avec le bouton du milieu 
-   de la souris.
+ * **Note**: To control the zoom on the map, use the <Ctrl> key with the left mouse button.
+   To move around on the map, the <Ctrl> key should be used with the mouse wheel [or the middle mouse button].
 
-Nous sélectionnons 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 :
+Select point A then point B sequentially, using the *Activate point A selection*
+then *Activate point B selection* buttons. Once the two points have been selected,
+the georeferencing dialog box looks like this:
 
   |selection_B2|
 
-Pour les coordonnées x,y de chaque point, la première colonne donne les coordonnées du pixel de l'image, 
-la deuxième colonne donne les coordonnées géographiques.
+For the x,y coordinates of each point, the first column gives the coordinates of the image pixel and the second
+column gives the geographical references.
 
-Nous validons le géoréférencement avec le bouton *Apply and Close*.
-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|. 
+The georeferencing is validated by clicking on the *Apply and Close* button.
+You must ensure that the "eye" icon to the left of the image name in the tree is active
+and re-centre the image using the *fit all* button: |fit_all|.
 
-L'image obtenue est légèrement inclinée vers la droite.
+ The image obtained is slightly tilted to the right.
 
- * **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, 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* :
+ * Note: in this view, the zoom may be performed with the mouse wheel.
+   The zoom may be centred on the mouse position or at the centre of the image.
+   This option is accessible in the *File/preferences* menu under the *SALOME* section,
+   *3D viewer* tab, *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.
+When you move the mouse over the map, the cursor coordinates are displayed in the status bar at the bottom left
+of the 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. 
+ * **Note**: you must get used to **saving the current study regularly** (menu *File/Save* or *File/Save as*).
+   It is also advised to save the different steps of the study in different files:
+   *there have been previous instances where, under specific circumstances that are difficult to reproduce,
+   the study was saved in an incomplete state*. This problem has only arisen in cases where studies
+   incorporating data from several modules were being reloaded without the HYDRO module being activated
+   before the save operation.
+   To guard against the risk of an incomplete save, check that the HYDRO module is activated before saving the study.
 
-Import d'une deuxième image, géoréférencée à partir la première
-===============================================================
+Importing a second image, georeferenced from the first
+======================================================
 
-La deuxième image est au même endroit que la première ::
+The second image is stored in the same place as the first ::
 
   <appli_xxx>/bin/salome/test/HYDRO/garonne_ign_02.png
 
-Pour la géoréférencer, nous utilisons l'option *choose points on the reference image* du dialogue.
-Après avoir sélectionné la première image comme référence, nous voyons les deux images l'une en dessus de l'autre.
-Nous sélectionnons 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 :
+This image is georeferenced using choose points on the reference image option in the diolog box.
+Once the first image has been selected as reference, the two images are seen one above the other.
+First, a point A is selected at the same location on both images, then a point B.
+These two points should be as far apart as possible and the zoom sufficiently close to be precise.
+The dialog box should now look like the one below:
 
   |import_image_B|
 
-Après avoir validé le dialogue, puis affiché les deux images et recentré la vue, nous obtenons :
+After having confirmed the dialog instructions and then displayed both images and re-centred the view,
+the following is obtained:
 
   |deux_images|
 
-Définition d'un repère local
-============================
+Definition of a local coordinate system
+=======================================
+
+Using a local reference point as origin reduces the size of the numbers being handled.
+Changing the origin significantly improves the precision of the geometry, mesh and calculation steps.
+On the contrary, keeping the large number values of the initial coordinates makes it impossible
+to obtain a good quality mesh.
 
-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é.
+The coordinates of the new origin are entered via the *HYDRO/Change Local CS* menu.
 
-Dans le menu *HYDRO/Change Local CS*, nous saisissons les coordonnées de la nouvelle origine.
+In this example, the point (430 000, 6 350 000), located to the south west of our study domain, is entered.
 
-Pour notre exemple, nous prenons pour origine le point (430 000, 6 350 000) situé
-au sud ouest de notre domaine d'étude.
+After confirming the change of origin, one sees that the cursor coordinates, which are displayed in the status bar
+at the bottom left of the application, are provided in both coordinate systems (local and global).
 
-Après avoir validé le changement de repère, nous constatons 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).
+ * **Note**: this change of origin can be made several times, at different points in the study,
+   as everything that was previously imported is transposed by the application.
+   However it is preferable to do this quite early to minimise the risks of error or inconsistency and,
+   in any event, before exporting the HYDRO module elements, particularly the model geometry.
+   It is recommended to set the local coordinate system early in the study,
+   as soon as the extent of the computational domain is known.
 
-  * **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**.
-    
-  * Après un changement de repère local, if faut mettre à jour les données de l'arbre qui apparaissent en bleu italique
-    avec le menu contextuel *update*, puis recentrer la vue avec la commande *Fit All*.
+ * After a change of origin, some entries in the study tree are marked in italic blue: they must be updated.
+   Use the context menu *update*, then reset the view with *Fit All* command.
 
-Dump Python
+Python dump
 ===========
 
-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.
+All actions/operations completed through the graphic interface have their equivalent in Python script.
+A script dump of the study can be made using the *File/Dump Study* menu.
+The resulting Python script can be used to reconstruct the study data in a new SALOME study.
+This script is of course editable.
 
-On peut faire le dump après la définition du repère local, et comparer le fichier obtenu avec ::
+The dump can be made after definition of the local coordinate system and the obtained file compared with ::
 
   <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.
+The correct execution of the dump can be checked by starting again with a new study
+(restart SALOME, new document or just new document),
+then menu *File/Load Script* and activation of the HYDRO module.
 
 .. only:: html
 
-   :ref:`ref_exempleInondation`
+   :ref:`ref_english_exempleInondation`