Salome HOME
Merge changes from 'master' branch.
[plugins/netgenplugin.git] / src / NETGEN / ReadMeForNgUsers
1 # ------------------------------------------------------------------
2 # Notes about usage of Netgen with SALOME
3 # ------------------------------------------------------------------
4
5 -------------------
6 1. Netgen home page
7 -------------------
8
9 Netgen mesher's home page is: https://sourceforge.net/projects/netgen-mesher/.
10
11 -----------------------
12 2. Minimal requirements
13 -----------------------
14
15 Minimal version of Netgen required for SALOME is 5.3.1.
16
17 ----------------------------------------
18 3. Build Netgen for SALOME NETGEN Plugin
19 ----------------------------------------
20
21 3.1. Download Netgen archive (here netgen-5.3.1.tar.gz) from the project's site:
22
23        $ wget https://vorboss.dl.sourceforge.net/project/netgen-mesher/netgen-mesher/5.3/netgen-5.3.1.tar.gz
24
25 3.2. Unpack an archive:
26
27        $ tar xfz netgen-5.3.1.tar.gz
28
29 3.3. Patch the Netgen distribution for SALOME
30
31        $ cd netgen-5.3.1
32        $ patch -p1 < /path/to/netgenplugin_src_dir/src/NETGEN/netgen53ForSalome.patch
33
34      Here, "/path/to/netgenplugin_src_dir" is a path to NETGENPLUGIN source directory.
35      This is the same directory where this Readme file is located.
36      Netgen plugin sources can be retrieved from the Git repository:
37      
38        $ git clone http://git.salome-platform.org/gitpub/plugins/netgenplugin.git
39
40 3.4. Configure the netgen compilation:
41
42        $ cd netgen-5.3.1
43        $ ./configure --prefix=/path/to/the/installation/directory \
44          --with-occ=${CAS_ROOT_DIR} \
45          --with-tcl=${TCLHOME}/lib --with-tk=${TCLHOME}/lib \
46          --with-tclinclude=${TCLHOME}/include
47
48      Note: Netgen depends on some products like Open CASCADE Technology and Tcl/Tk.
49      These products should be specified to the configure script via options.
50
51 3.5. Compile and install netgen mesher:
52
53         $ make install
54
55 3.6. Patch the installation directory by copying header files
56      needed by NETGEN Plugin. For this purpose you can use the script
57      /path/to/netgenplugin_src_dir/src/NETGEN/netgen_copy_include_for_salome.
58
59         $ /path/to/netgenplugin_src_dir/src/NETGEN/netgen_copy_include_for_salome \
60           . /path/to/the/installation/directory
61
62      The first argument is the directory containing the Netgen sources.
63      The second argument is the installation directory of Netgen mesher.