Merge remote-tracking branch 'origin/BUGFIX/signInHerschelBuckley'
[foam-extend-3.0.git] / etc / prefs.sh-EXAMPLE
blobcc8fdd2027548a96d1f690ecf0c2b8eab28b855d
1 #----------------------------------*-sh-*--------------------------------------
2 # =========                 |
3 # \\      /  F ield         | foam-extend: Open Source CFD
4 #  \\    /   O peration     |
5 #   \\  /    A nd           | For copyright notice see file Copyright
6 #    \\/     M anipulation  |
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 OpenFOAM configuration - POSIX shell syntax.
30 #     The prefs.sh file will be sourced by the OpenFOAM etc/bashrc when it is
31 #     found
33 #------------------------------------------------------------------------------
35 export FOAM_VERBOSE=1
37 # Specify system compiler
38 # ~~~~~~~~~~~~~~~~~~~~~~~
39 compilerInstall=System
41 # Specify system openmpi
42 # ~~~~~~~~~~~~~~~~~~~~~~
44 # Normally, you don't need to set more than these 3 env. variables
45 # The other openmpi related variables will be initialized using
46 # the command mpicc --showme:
48 #export WM_MPLIB=SYSTEMOPENMPI
49 #export OPENMPI_DIR=path_to_system_installed_openmpi
50 #export OPENMPI_BIN_DIR=$OPENMPI_DIR/bin
52 #export OPENMPI_LIB_DIR="`$OPENMPI_BIN_DIR/mpicc --showme:libdirs`"
53 #export OPENMPI_INCLUDE_DIR="`$OPENMPI_BIN_DIR/mpicc --showme:incdirs`"
54 #export OPENMPI_COMPILE_FLAGS="`$OPENMPI_BIN_DIR/mpicc --showme:compile`"
55 #export OPENMPI_LINK_FLAGS="`$OPENMPI_BIN_DIR/mpicc --showme:link`"
57 # Specify system installed ThirdParty packages/libraries
58 # NB: The packages installed under $WM_THIRD_PARTY_DIR
59 #     will always override these values.
60 #     So build your ThirdParty directory accordingly.
61 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
63 # System installed CUDA
64 #export CUDA_SYSTEM=1
65 #export CUDA_DIR=path_to_system_installed_cuda
66 #export CUDA_BIN_DIR=$CUDA_DIR/bin
67 #export CUDA_LIB_DIR=$CUDA_DIR/lib
68 #export CUDA_INCLUDE_DIR=$CUDA_DIR/include
69 #export CUDA_ARCH=sm_20
71 # System installed Mesquite
72 #export MESQUITE_SYSTEM=1
73 #export MESQUITE_DIR=path_to_system_installed_mesquite
74 #export MESQUITE_BIN_DIR=$MESQUITE_DIR/bin
75 #export MESQUITE_LIB_DIR=$MESQUITE_DIR/lib
76 #export MESQUITE_INCLUDE_DIR=$MESQUITE_DIR/include
78 # System installed Metis
79 #export METIS_SYSTEM=1
80 #export METIS_DIR=path_to_system_installed_metis
81 #export METIS_BIN_DIR=$METIS_DIR/bin
82 #export METIS_LIB_DIR=$METIS_DIR/lib
83 #export METIS_INCLUDE_DIR=$METIS_DIR/include
85 # System installed ParMetis
86 #export PARMETIS_SYSTEM=1
87 #export PARMETIS_DIR=path_to_system_installed_parmetis
88 #export PARMETIS_BIN_DIR=$PARMETIS_DIR/bin
89 #export PARMETIS_LIB_DIR=$PARMETIS_DIR/lib
90 #export PARMETIS_INCLUDE_DIR=$PARMETIS_DIR/include
92 # System installed ParMGridgen
93 #export PARMGRIDGEN_SYSTEM=1
94 #export PARMGRIDGEN_DIR=path_to_system_installed_parmgridgen
95 #export PARMGRIDGEN_BIN_DIR=$PARMGRIDGEN_DIR/bin
96 #export PARMGRIDGEN_LIB_DIR=$PARMGRIDGEN_DIR/lib
97 #export PARMGRIDGEN_INCLUDE_DIR=$PARMGRIDGEN_DIR/include
99 # System installed Libccmio
100 #export LIBCCMIO_SYSTEM=1
101 #export LIBCCMIO_DIR=path_to_system_installed_libccmio
102 #export LIBCCMIO_BIN_DIR=$LIBCCMIO_DIR/bin
103 #export LIBCCMIO_LIB_DIR=$LIBCCMIO_DIR/lib
104 #export LIBCCMIO_INCLUDE_DIR=$LIBCCMIO_DIR/include
106 # System installed Scotch
107 #export SCOTCH_SYSTEM=1
108 #export SCOTCH_DIR=path_to_system_installed_scotch
109 #export SCOTCH_BIN_DIR=$SCOTCH_DIR/bin
110 #export SCOTCH_LIB_DIR=$SCOTCH_DIR/lib
111 #export SCOTCH_INCLUDE_DIR=$SCOTCH_DIR/include
113 # System installed CMake
114 #export CMAKE_SYSTEM=1
115 #export CMAKE_DIR=path_to_system_installed_cmake
116 #export CMAKE_BIN_DIR=$CMAKE_DIR/bin
118 # System installed Python
119 #export PYTHON_SYSTEM=1
120 #export PYTHON_DIR=path_to_system_installed_python
121 #export PYTHON_BIN_DIR=$PYTHON_DIR/bin
123 # System installed PyFoam
124 #export PYFOAM_SYSTEM=1
125 #export PYFOAM_DIR=path_to_system_installed_python
126 #export PYFOAM_BIN_DIR=$PYFOAM_DIR/bin
128 # System installed hwloc
129 #export HWLOC_SYSTEM=1
130 #export HWLOC_DIR=path_to_system_installed_hwloc
131 #export HWLOC_BIN_DIR=$HWLOC_DIR/bin
133 # System installed Qt
134 # This is the only package we assume is system installed by default.
135 # So we don't use a variable called QT_SYSTEM, but instead a variable
136 # called QT_THIRD_PARTY in order to override to the ThirdParty QT
137 # package.
139 # If you choose to use the system installed version of QT, keep
140 # the variable QT_THIRD_PARTY commented, and uncomment the initialization
141 # of the variable QT_DIR and QT_BIN_DIR. Make sure both variables are
142 # properly initialized.
144 # If you choose instead to use the ThirdParty version of QT, only uncomment
145 # the variable QT_THIRD_PARTY and set it to 1. Keep the initialization
146 # of the variables QT_DIR nd QT_BIN_DIR commented. The QT ThirdParty scripts
147 # will take care of setting the variables QT_DIR and QT_BIN_DIR to the
148 # proper values.
150 #export QT_THIRD_PARTY=1
151 #export QT_DIR=path_to_system_installed_qt
152 #export QT_BIN_DIR=$QT_DIR/bin
154 # System installed ParaView
155 #export PARAVIEW_SYSTEM=1
156 #export PARAVIEW_DIR=path_to_system_installed_paraview
157 #export PARAVIEW_BIN_DIR=$PARAVIEW_DIR/bin
159 # System installed bison
160 #export BISON_SYSTEM=1
162 # System installed flex
163 #export FLEX_SYSTEM=1
165 # System installed m4
166 #export M4_SYSTEM=1
168 # Specify ParaView version
169 # ~~~~~~~~~~~~~~~~~~~~~~~~
170 #export ParaView_VERSION=git        # eg, cvs/git version
171 #export ParaView_MAJOR=3.7
174 # System identifier for the OpenFOAM CDash test harness on openfoam-extend
176 # By default, your system FQN/hostname will be used as the system identifier
177 # when publishing your test harness results on the OpenFOAM CDash server
178 # on openfoam-extend.
179 # You can override your identifier using this environment variable
180 #export CDASH_SUBMIT_LOCAL_HOST_ID=choose_your_CDash_system_identifer
182 # ----------------------------------------------------------------- end-of-file