ThirdParty packages: Fix typos for some .csh files. Add some comments in the etc...
[openfoam-extend-OpenFOAM-1.6-ext.git] / etc / prefs.sh-EXAMPLE
blob07c6d22949494bfc88de3b960ad5b3b8889c31cf
1 #----------------------------------*-sh-*--------------------------------------
2 # =========                 |
3 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4 #  \\    /   O peration     |
5 #   \\  /    A nd           | Copyright (C) 2010-2010 OpenCFD Ltd.
6 #    \\/     M anipulation  |
7 #------------------------------------------------------------------------------
8 # License
9 #     This file is part of OpenFOAM.
11 #     OpenFOAM is free software: you can redistribute it and/or modify it
12 #     under the terms of the GNU General Public License as published by
13 #     the Free Software Foundation, either version 3 of the License, or
14 #     (at your option) any later version.
16 #     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17 #     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18 #     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19 #     for more details.
21 #     You should have received a copy of the GNU General Public License
22 #     along with OpenFOAM.  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 by foamEtcFile.
33 # See Also
34 #     'foamEtcFile -help' or 'foamEtcFile -list' for information about the
35 #     paths searched
37 #------------------------------------------------------------------------------
39 export FOAM_VERBOSE=1
41 # Specify system compiler
42 # ~~~~~~~~~~~~~~~~~~~~~~~
43 compilerInstall=system
45 # Specify system openmpi
46 # ~~~~~~~~~~~~~~~~~~~~~~
48 # Normally, you don't need to set more than these 3 env. variables
49 # The other openmpi related variables will be initialized using 
50 # the command mpicc --showme:
52 #export WM_MPLIB=SYSTEMOPENMPI
53 #export OPENMPI_DIR=path_to_system_installed_openmpi
54 #export OPENMPI_BIN_DIR=$OPENMPI_DIR/bin
56 #export OPENMPI_LIB_DIR="`$OPENMPI_BIN_DIR/mpicc --showme:libdirs`"
57 #export OPENMPI_INCLUDE_DIR="`$OPENMPI_BIN_DIR/mpicc --showme:incdirs`"
58 #export OPENMPI_COMPILE_FLAGS="`$OPENMPI_BIN_DIR/mpicc --showme:compile`"
59 #export OPENMPI_LINK_FLAGS="`$OPENMPI_BIN_DIR/mpicc --showme:link`"
61 # Specify system installed ThirdParty packages/libraries
62 # NB: The packages installed under $WM_THIRD_PARTY_DIR
63 #     will always override these values. 
64 #     So build your ThirdParty directory accordingly.
65 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
67 # System installed Mesquite
68 #export MESQUITE_SYSTEM=1
69 #export MESQUITE_DIR=path_to_system_installed_mesquite
70 #export MESQUITE_BIN_DIR=$MESQUITE_DIR/bin
71 #export MESQUITE_LIB_DIR=$MESQUITE_DIR/lib
72 #export MESQUITE_INCLUDE_DIR=$MESQUITE_DIR/include
74 # System installed Metis
75 #export METIS_SYSTEM=1
76 #export METIS_DIR=path_to_system_installed_metis
77 #export METIS_BIN_DIR=$METIS_DIR/bin
78 #export METIS_LIB_DIR=$METIS_DIR/lib
79 #export METIS_INCLUDE_DIR=$METIS_DIR/include
81 # System installed ParMetis
82 #export PARMETIS_SYSTEM=1
83 #export PARMETIS_DIR=path_to_system_installed_parmetis
84 #export PARMETIS_BIN_DIR=$PARMETIS_DIR/bin
85 #export PARMETIS_LIB_DIR=$PARMETIS_DIR/lib
86 #export PARMETIS_INCLUDE_DIR=$PARMETIS_DIR/include
88 # System installed ParMGridgen
89 #export PARMGRIDGEN_SYSTEM=1
90 #export PARMGRIDGEN_DIR=path_to_system_installed_parmgridgen
91 #export PARMGRIDGEN_BIN_DIR=$PARMGRIDGEN_DIR/bin
92 #export PARMGRIDGEN_LIB_DIR=$PARMGRIDGEN_DIR/lib
93 #export PARMGRIDGEN_INCLUDE_DIR=$PARMGRIDGEN_DIR/include
95 # System installed Scotch
96 #export SCOTCH_SYSTEM=1
97 #export SCOTCH_DIR=path_to_system_installed_scotch
98 #export SCOTCH_BIN_DIR=$SCOTCH_DIR/bin
99 #export SCOTCH_LIB_DIR=$SCOTCH_DIR/lib
100 #export SCOTCH_INCLUDE_DIR=$SCOTCH_DIR/include
102 # System installed CMake
103 #export CMAKE_SYSTEM=1
104 #export CMAKE_DIR=path_to_system_installed_cmake
105 #export CMAKE_BIN_DIR=$CMAKE_DIR/bin
107 # System installed Python
108 #export PYTHON_SYSTEM=1
109 #export PYTHON_DIR=path_to_system_installed_python
110 #export PYTHON_BIN_DIR=$PYTHON_DIR/bin
112 # System installed Qt
113 # This is the only package we assume is system installed by default.
114 # So we don't use a variable called QT_SYSTEM, but instead a variable
115 # called QT_THIRD_PARTY in order to override to the ThirdParty QT
116 # package.
118 # If you choose to use the system installed version of QT, keep
119 # the variable QT_THIRD_PARTY commented, and uncomment the initialization
120 # of the variable QT_DIR and QT_BIN_DIR. Make sure both variables are
121 # properly initialized.
123 # If you choose instead to use the ThirdParty version of QT, only uncomment
124 # the variable QT_THIRD_PARTY and set it to 1. Keep the initialization 
125 # of the variables QT_DIR nd QT_BIN_DIR commented. The QT ThirdParty scripts
126 # will take care of setting the variables QT_DIR and QT_BIN_DIR to the 
127 # proper values.
129 #export QT_THIRD_PARTY=1
130 #export QT_DIR=path_to_system_installed_qt
131 #export QT_BIN_DIR=$QT_DIR/bin
133 # System installed ParaView
134 #export PARAVIEW_SYSTEM=1
135 #export PARAVIEW_DIR=path_to_system_installed_paraview
136 #export PARAVIEW_BIN_DIR=$PARAVIEW_DIR/bin
138 # Specify ParaView version
139 # ~~~~~~~~~~~~~~~~~~~~~~~~
140 #export ParaView_VERSION=git        # eg, cvs/git version
141 #export ParaView_MAJOR=3.7
143 # ----------------------------------------------------------------- end-of-file