Updated instructions. Miguel Nobrega
[foam-extend-3.2.git] / etc / prefs.sh-EXAMPLE
bloba6897d035958c2cbeeee9abac0fd0f9147dc6ab5
1 #----------------------------------*-sh-*--------------------------------------
2 # =========                 |
3 # \\      /  F ield         | foam-extend: Open Source CFD
4 #  \\    /   O peration     | Version:     3.2
5 #   \\  /    A nd           | Web:         http://www.foam-extend.org
6 #    \\/     M anipulation  | For copyright notice see file Copyright
7 #------------------------------------------------------------------------------
8 # License
9 #     This file is part of foam-extend.
11 #     foam-extend is free software: you can redistribute it and/or modify it
12 #     under the terms of the GNU General Public License as published by the
13 #     Free Software Foundation, either version 3 of the License, or (at your
14 #     option) any later version.
16 #     foam-extend is distributed in the hope that it will be useful, but
17 #     WITHOUT ANY WARRANTY; without even the implied warranty of
18 #     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 #     General Public License for more details.
21 #     You should have received a copy of the GNU General Public License
22 #     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 # File
25 #     etc/prefs.sh
27 # Description
28 #     Preset variables for the FOAM configuration - POSIX shell syntax.
30 #     The prefs.sh file will be sourced by the FOAM etc/bashrc when it is
31 #     found
33 #------------------------------------------------------------------------------
35 export FOAM_VERBOSE=1
37 # Specify system compiler
38 # ~~~~~~~~~~~~~~~~~~~~~~~
39 #compilerInstall=System
40 #compilerInstall=FOAM
42 # Specify system openmpi
43 # ~~~~~~~~~~~~~~~~~~~~~~
45 # Normally, you don't need to set more than these 3 env. variables
46 # The other openmpi related variables will be initialized using
47 # the command mpicc --showme:
49 #export WM_MPLIB=SYSTEMOPENMPI
50 #export OPENMPI_DIR=path_to_system_installed_openmpi
51 #export OPENMPI_BIN_DIR=$OPENMPI_DIR/bin
53 #export OPENMPI_LIB_DIR="`$OPENMPI_BIN_DIR/mpicc --showme:libdirs`"
54 #export OPENMPI_INCLUDE_DIR="`$OPENMPI_BIN_DIR/mpicc --showme:incdirs`"
55 #export OPENMPI_COMPILE_FLAGS="`$OPENMPI_BIN_DIR/mpicc --showme:compile`"
56 #export OPENMPI_LINK_FLAGS="`$OPENMPI_BIN_DIR/mpicc --showme:link`"
58 # Specify system installed ThirdParty packages/libraries
59 # NB: The packages installed under $WM_THIRD_PARTY_DIR
60 #     will always override these values.
61 #     So build your ThirdParty directory accordingly.
62 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
64 # System installed CUDA
65 #export CUDA_SYSTEM=1
66 #export CUDA_DIR=path_to_system_installed_cuda
67 #export CUDA_BIN_DIR=$CUDA_DIR/bin
68 #export CUDA_LIB_DIR=$CUDA_DIR/lib
69 #export CUDA_INCLUDE_DIR=$CUDA_DIR/include
70 #export CUDA_ARCH=sm_20
72 # System installed Mesquite
73 #export MESQUITE_SYSTEM=1
74 #export MESQUITE_DIR=path_to_system_installed_mesquite
75 #export MESQUITE_BIN_DIR=$MESQUITE_DIR/bin
76 #export MESQUITE_LIB_DIR=$MESQUITE_DIR/lib
77 #export MESQUITE_INCLUDE_DIR=$MESQUITE_DIR/include
79 # System installed Metis
80 #export METIS_SYSTEM=1
81 #export METIS_DIR=path_to_system_installed_metis
82 #export METIS_BIN_DIR=$METIS_DIR/bin
83 #export METIS_LIB_DIR=$METIS_DIR/lib
84 #export METIS_INCLUDE_DIR=$METIS_DIR/include
86 # System installed ParMetis
87 #export PARMETIS_SYSTEM=1
88 #export PARMETIS_DIR=path_to_system_installed_parmetis
89 #export PARMETIS_BIN_DIR=$PARMETIS_DIR/bin
90 #export PARMETIS_LIB_DIR=$PARMETIS_DIR/lib
91 #export PARMETIS_INCLUDE_DIR=$PARMETIS_DIR/include
93 # System installed ParMGridgen
94 #export PARMGRIDGEN_SYSTEM=1
95 #export PARMGRIDGEN_DIR=path_to_system_installed_parmgridgen
96 #export PARMGRIDGEN_BIN_DIR=$PARMGRIDGEN_DIR/bin
97 #export PARMGRIDGEN_LIB_DIR=$PARMGRIDGEN_DIR/lib
98 #export PARMGRIDGEN_INCLUDE_DIR=$PARMGRIDGEN_DIR/include
100 # System installed Libccmio
101 #export LIBCCMIO_SYSTEM=1
102 #export LIBCCMIO_DIR=path_to_system_installed_libccmio
103 #export LIBCCMIO_BIN_DIR=$LIBCCMIO_DIR/bin
104 #export LIBCCMIO_LIB_DIR=$LIBCCMIO_DIR/lib
105 #export LIBCCMIO_INCLUDE_DIR=$LIBCCMIO_DIR/include
107 # System installed Scotch
108 #export SCOTCH_SYSTEM=1
109 #export SCOTCH_DIR=path_to_system_installed_scotch
110 #export SCOTCH_BIN_DIR=$SCOTCH_DIR/bin
111 #export SCOTCH_LIB_DIR=$SCOTCH_DIR/lib
112 #export SCOTCH_INCLUDE_DIR=$SCOTCH_DIR/include
114 # System installed CMake
115 #export CMAKE_SYSTEM=1
116 #export CMAKE_DIR=path_to_system_installed_cmake
117 #export CMAKE_BIN_DIR=$CMAKE_DIR/bin
119 # System installed Python
120 #export PYTHON_SYSTEM=1
121 #export PYTHON_DIR=path_to_system_installed_python
122 #export PYTHON_BIN_DIR=$PYTHON_DIR/bin
124 # System installed PyFoam
125 #export PYFOAM_SYSTEM=1
126 #export PYFOAM_DIR=path_to_system_installed_python
127 #export PYFOAM_BIN_DIR=$PYFOAM_DIR/bin
129 # System installed hwloc
130 #export HWLOC_SYSTEM=1
131 #export HWLOC_DIR=path_to_system_installed_hwloc
132 #export HWLOC_BIN_DIR=$HWLOC_DIR/bin
134 # System installed Qt
135 # This is the only package we assume is system installed by default.
136 # So we don't use a variable called QT_SYSTEM, but instead a variable
137 # called QT_THIRD_PARTY in order to override to the ThirdParty QT
138 # package.
140 # If you choose to use the system installed version of QT, keep
141 # the variable QT_THIRD_PARTY commented, and uncomment the initialization
142 # of the variable QT_DIR and QT_BIN_DIR. Make sure both variables are
143 # properly initialized.
145 # If you choose instead to use the ThirdParty version of QT, only uncomment
146 # the variable QT_THIRD_PARTY and set it to 1. Keep the initialization
147 # of the variables QT_DIR nd QT_BIN_DIR commented. The QT ThirdParty scripts
148 # will take care of setting the variables QT_DIR and QT_BIN_DIR to the
149 # proper values.
151 #export QT_THIRD_PARTY=1
152 #export QT_DIR=path_to_system_installed_qt
153 #export QT_BIN_DIR=$QT_DIR/bin
155 # System installed ParaView
156 #export PARAVIEW_SYSTEM=1
157 #export PARAVIEW_DIR=path_to_system_installed_paraview
158 #export PARAVIEW_BIN_DIR=$PARAVIEW_DIR/bin
160 # System installed bison
161 #export BISON_SYSTEM=1
163 # System installed flex
164 #export FLEX_SYSTEM=1
166 # System installed m4
167 #export M4_SYSTEM=1
169 # Specify ParaView version
170 # ~~~~~~~~~~~~~~~~~~~~~~~~
171 #export ParaView_VERSION=git        # eg, cvs/git version
172 #export ParaView_MAJOR=3.7
175 # System identifier for the FOAM CDash test harness on foam-extend
177 # By default, your system FQN/hostname will be used as the system identifier
178 # when publishing your test harness results on the FOAM CDash server
179 # on foam-extend.
180 # You can override your identifier using this environment variable
181 #export CDASH_SUBMIT_LOCAL_HOST_ID=choose_your_CDash_system_identifer
183 # Buildname suffix for the FOAM CDash test harness on foam-extend 
184 # By default, the git branch name and git revision number will be
185 # appended to the CDash build name.
186 # Otherwise, for users not using git, or wanting to provide additionnal
187 # information, simply initialize the CDASH_SCM_INFO with the proper information
188 #export CDASH_SCM_INFO=your_SCM_information
190 # Mac OS X MacPorts root directory.
191 # The default value is '/opt/local/etc/macports'.
192 # In order to disable the usage of MacPorts on Mac OSX, simply initialize this
193 # variable to a non-existing directory, or to a dummy value.
194 #export MACOSX_MACPORTS_ROOT="_not_using_"
196 # ThirdParty packages: build control variables
197 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198 # By enabling any of these variables, you will active the compilation and
199 # installation of the corresponding ThirdParty package
201 # For AllMake.stage1
202 #export WM_THIRD_PARTY_USE_GCC_492=1
203 #export WM_THIRD_PARTY_USE_GCC_484=1
204 #export WM_THIRD_PARTY_USE_GCC_463=1
205 #export WM_THIRD_PARTY_USE_GCC_451=1
206 #export WM_THIRD_PARTY_USE_GCC_445=1
207 #export WM_THIRD_PARTY_USE_PYTHON_27=1
208 #export WM_THIRD_PARTY_USE_M4_1416=1
209 #export WM_THIRD_PARTY_USE_BISON_27=1
210 #export WM_THIRD_PARTY_USE_FLEX_2535=1
211 export WM_THIRD_PARTY_USE_CMAKE_322=1
214 # For AllMake.stage2
215 export WM_THIRD_PARTY_USE_OPENMPI_188=1
216 #export WM_THIRD_PARTY_USE_OPENMPI_188_ConfigureAdditionalArgs='--enable-mpi-cxx --with-openib=/usr --with-openib-libdir=/usr/lib64'
217 #export WM_THIRD_PARTY_USE_OPENMPI_165=1
218 #export WM_THIRD_PARTY_USE_OPENMPI_165_ConfigureAdditionalArgs='--enable-mpi-cxx --with-openib=/usr --with-openib-libdir=/usr/lib64'
219 #export WM_THIRD_PARTY_USE_OPENMPI_15=1
220 #export WM_THIRD_PARTY_USE_OPENMPI_143=1
221 #export WM_THIRD_PARTY_USE_OPENMPI_141=1
224 # For AllMake.stage3
225 export WM_THIRD_PARTY_USE_METIS_510=1
226 export WM_THIRD_PARTY_USE_PARMGRIDGEN_10=1
227 export WM_THIRD_PARTY_USE_LIBCCMIO_261=1
228 export WM_THIRD_PARTY_USE_MESQUITE_212=1
229 export WM_THIRD_PARTY_USE_SCOTCH_604=1
230 #export WM_THIRD_PARTY_USE_SCOTCH_600=1
231 export WM_THIRD_PARTY_USE_PARMETIS_403=1
232 #export WM_THIRD_PARTY_USE_ZOLTAN_36=1
233 export WM_THIRD_PARTY_USE_PYFOAM_064=1
234 export WM_THIRD_PARTY_USE_HWLOC_1101=1
235 #export WM_THIRD_PARTY_USE_HWLOC_172=1
238 # For AllMake.stage4
239 export WM_THIRD_PARTY_USE_QT_486=1
240 export WM_THIRD_PARTY_USE_PARAVIEW_431=1
241 #export WM_THIRD_PARTY_USE_PARAVIEW_410=1
244 # Add in preset user preferences: will override site preferences
245 if [ -e $WM_PROJECT_USER_DIR/etc/prefs.sh ]
246 then
247     _foamSource $WM_PROJECT_USER_DIR/etc/prefs.sh
249 # ----------------------------------------------------------------- end-of-file