]> SALOME platform Git repositories - modules/paravis.git/blob - README
Salome HOME
[salome test] Update list of tests
[modules/paravis.git] / README
1 ********************
2 About SALOME ParaVis
3 ********************
4
5 SALOME ParaVis wraps ParaView (http://www.paraview.org/) GUI and makes it available
6 in SALOME application.
7
8 For more information please visit the SALOME platform web site:
9
10   <http://www.salome-platform.org/>
11
12 =======
13 License
14 =======
15
16 SALOME platform is distributed under the GNU Lesser General Public License.
17 See COPYING file for more details.
18
19 Also, additional information can be found at SALOME platform web site:
20
21   <http://www.salome-platform.org/downloads/license/>
22
23 ============
24 Installation
25 ============
26
27 --------------
28 Pre-requisites
29 --------------
30
31 SALOME platform relies on a set of third-party softwares; some of them are needed
32 at build time only, while other ones are needed in runtime also.
33
34 For more information about the pre-requisites please visit SALOME platform web
35 site:
36
37 * Check Release Notes and Software Requirements of the latest SALOME release at
38
39   <http://www.salome-platform.org/downloads/current-version/>
40
41 * Pre-requisites page at SALOME web site:
42
43   <http://www.salome-platform.org/downloads/license/>
44
45 Note: SALOME ParaVis module needs the following SALOME modules and tools:
46 - SALOME KERNEL
47 - SALOME GUI
48 - SALOME Med (optionally)
49 - SALOME Geometry (optionally)
50 - SALOME Mesh (optionally)
51 - MedCoupling (optionally)
52
53 ------------------
54 Basic Installation
55 ------------------
56
57 The build procedure of the SALOME platform is implemented with CMake.
58 In order to build the module you have to do the following actions: 
59
60 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
61
62 2. Create a build directory:
63
64    % mkdir PARAVIS_BUILD
65
66 3. Configure the build procedure:
67
68    % cd PARAVIS_BUILD
69    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
70
71    where
72    - <mode> is either Release or Debug (default: Release);
73    - <installation_directory> is a destination folder to install SALOME ParaVis
74       module (default: /usr); 
75    - <path_to_src_dir> is a path to the SALOME ParaVis sources directory.
76
77    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME ParaVis
78    module will be configured for installation to the /usr directory that requires
79    root permissions to complete the installation.
80
81 4. Build and install:
82
83    % make
84    % make install
85
86    This will install SALOME ParaVis module to the <installation_directory>
87    specified to cmake command on the previous step.
88
89 -------------------
90 Custom installation
91 -------------------
92
93 SALOME ParaVis module supports a set of advanced configuration options;
94 for more details learn CMakeLists.txt file in the root source directory.
95
96 You can also use other options of cmake command to customize your installation.
97 Learn more about available options by typing
98
99    % cmake --help
100
101 =============
102 Documentation
103 =============
104
105 The directory doc contains additional documentation file of SALOME ParaVis module.
106
107 ===============
108 Troubleshooting
109 ===============
110
111 Please, send a mail to webmaster.salome@opencascade.com.