Salome HOME
fix warnings on tutorial build
[modules/hydro.git] / doc / salome / tutorial / english / english_installationLancementSalome.rst
1 ..
2    Copyright (C) 2015-2016 EDF
3
4    This file is part of SALOME HYDRO module.
5
6    SALOME HYDRO module is free software: you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation, either version 3 of the License, or
9    (at your option) any later version.
10
11    SALOME HYDRO module is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
18
19
20 ##########################################
21 SALOME installation and start-up procedure 
22 ##########################################
23
24 .. |fit_all| image:: ../_static/fitall.png
25    :align: middle
26
27 Installation
28 ============
29
30 You should obtain an installation file for SALOME_HYDRO: *xxx*.run.
31 Inside EDF, SALOME_HYDRO is available on the EDF intranet:
32
33  * Open an account (e.g.: I88928)
34
35  * Open a web browser (blue button at the top right or Applications/Internet/Navigation Web Iceweasel) 
36
37  * Type the address: https://salome.der.edf.fr/ 
38
39  * Look for the latest version of SALOME_HYDRO in the folder:  Downloads (Téléchargements)
40
41  * Extract the *xxx*.run file
42
43  * Save (the file is automatically saved in /Downloads (Téléchargements)) 
44
45  * Open a terminal (at the top of the screen:  Accessories  (Accessoires)/Terminal) 
46
47  * Type cd Téléchargements (Downloads) 
48
49  * Type ls: you should see the *xxx*.run 
50
51 For everybody:
52
53  * (if necessary, make it executable: chmod +x *xxx*.run) 
54
55  * Start the installation by typing ./*xxx*.run 
56
57  * Answer the installation questions (directory: of your choice; **language: must be English**
58    (the option has been removed, as there is no choice);
59    for all remaining questions, if any:  yes by default) 
60
61 Salome-Hydro is now installed and appears as an icon on the desktop.
62 The icon can be dragged and dropped into an open editor (gedit or equivalent)
63 to replace the *Terminal=false* line by *Terminal=true*.
64 This provides an execution trace, facilitating the diagnosis of certain application problems.
65 It is not a compulsory step. 
66
67 The installation is in English because the translation into French is incomplete.
68
69 Starting SALOME
70 ===============
71  
72 Double-click the SALOME icon on the desktop, or, knowing the installation folder of SALOME ( *<appli_XXX>* ),
73 in a terminal ::
74
75   <appli_XXX>/salome
76
77 It is possible to get execution log in case of problem, in the terminal.  
78
79 * **Note** : the *salome* command accepts options.
80   For instance, -k option closes all previous SALOME instances and releases all associated resources.
81   To get help, use -h option ::
82
83   <appli_XXX>/salome -h
84
85 View handling in SALOME
86 =======================
87
88 For those users unfamiliar with SALOME, the following paragraphs describe the main 2D and 3D view-handling commands, as well as techniques to select and display objects in the study tree (Object Browser).
89  
90 Display data in the view window:
91 --------------------------------
92
93 By clicking the eye icon next to the object in the Object Browser window. 
94
95 By right clicking on the object in the tree on the left (in the Object Browser window),
96 which brings up a list of options::
97
98   /show/ show only / hide / hide only / hide all / 
99
100 Zoom
101 ----
102
103 Ctrl + left click 
104
105 The zoom is centred by default. Activation of zoom using the scroll (mouse) wheel: 
106 to enable use of the scroll wheel to control the zoom, this option must be activated:
107 file /preferences (select the SALOME module) /3D viewer /zooming style /relative to the cursor.
108 A zoom relative to the cursor pans in to the area around the cursor position
109 while a centred zoom pans out to takes account of the whole zone.
110  
111 To zoom in on a data item in the tree: 
112
113 Select the item from the tree. In the toolbar at the top of the window, 
114 select the Fit All button 
115
116 Rotation
117 --------
118
119 Ctrl + right click 
120
121 Translation (horizontal/vertical movements)
122 -------------------------------------------
123
124 Ctrl + mouse wheel
125
126 Viewers
127 -------
128
129 SALOME proposes several viewers:
130  
131 VTK for the 3D views (MESH module) and OCC for the 2D views (for the geometry).
132 These can be found via tabs that appear on the screen.
133
134 The different elements of the study are not all displayed equally well in all the viewers!
135