Salome HOME
Update translations to French
[modules/smesh.git] / README
1 *****************
2 About SALOME Mesh
3 *****************
4
5 SALOME Mesh module implements the functionalities for:
6 - Creating meshes in different ways:
7   * By meshing geometrical models previously created or imported by the Geometry
8     component;
9   * Bottom-up, using mesh edition operations, especially extrusion and revolution;
10   * By generation of the 3D mesh from the 2D mesh (the latter can be either imported
11     or manually created).
12 - Importing and exporting meshes in various formats.
13 - Modifying meshes with a vast array of dedicated operations.
14 - Creating groups of mesh elements.
15 - Filtering mesh entities (nodes or elements) using Filters functionality for
16   creating groups and applying mesh modifications.
17 - Viewing meshes in the VTK viewer and getting info on mesh and its sub-objects.
18 - Applying to meshes Quality Controls, allowing to highlight important elements.
19 - Taking various measurements of the mesh objects.
20
21 For more information please visit the SALOME platform web site:
22
23   <http://www.salome-platform.org/>
24
25 =======
26 License
27 =======
28
29 SALOME platform is distributed under the GNU Lesser General Public License.
30 See COPYING file for more details.
31
32 Also, additional information can be found at SALOME platform web site:
33
34   <http://www.salome-platform.org/downloads/license/>
35
36 ============
37 Installation
38 ============
39
40 --------------
41 Pre-requisites
42 --------------
43
44 SALOME platform relies on a set of third-party software; some of them are needed
45 at build time only, while other ones are needed in runtime also.
46
47 For more information about the pre-requisites please visit SALOME platform web
48 site:
49
50 * Check Release Notes and Software Requirements of the latest SALOME release at
51
52   <http://www.salome-platform.org/downloads/current-version/>
53
54 * Pre-requisites page at SALOME web site:
55
56   <http://www.salome-platform.org/downloads/license/>
57
58 Note: SALOME Mesh module needs SALOME KERNEL, SALOME GUI and SALOME Geometry as
59 pre-requisites.
60
61 ------------------
62 Basic Installation
63 ------------------
64
65 The build procedure of the SALOME platform is implemented with CMake.
66 In order to build the module you have to do the following actions: 
67
68 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
69
70 2. Create a build directory:
71
72    % mkdir SMESH_BUILD
73
74 3. Configure the build procedure:
75
76    % cd SMESH_BUILD
77    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
78
79    where
80    - <mode> is either Release or Debug (default: Release);
81    - <installation_directory> is a destination folder to install SALOME Mesh
82       module (default: /usr); 
83    - <path_to_src_dir> is a path to the SALOME Mesh sources directory.
84
85    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME Mesh
86    module will be configured for installation to the /usr directory that requires
87    root permissions to complete the installation.
88
89 4. Build and install:
90
91    % make
92    % make install
93
94    This will install SALOME Mesh module to the <installation_directory>
95    specified to cmake command on the previous step.
96
97 -------------------
98 Custom installation
99 -------------------
100
101 SALOME Mesh module supports a set of advanced configuration options;
102 for more details learn CMakeLists.txt file in the root source directory.
103
104 You can also use other options of cmake command to customize your installation.
105 Learn more about available options by typing
106
107    % cmake --help
108
109 =============
110 Documentation
111 =============
112
113 The directory doc contains additional documentation file of SALOME Mesh module.
114
115 ===============
116 Troubleshooting
117 ===============
118
119 Please, send a mail to webmaster.salome@opencascade.com.