= Introduction =
This page is dedicated to explaining how to install {{OpenFOAM}} {{version6}} in:
* Community ENTerprise Operating System, aka '''CentOS'''.
* Red Hat Enterprise Linux, aka '''RHEL'''.
* Scientific Linux, aka '''SL'''.
In '''theory''', all of the above follow the same versioning. Therefore, at the time this page was first written, RHEL, CentOS and SL were all at version {{tt|6.10}}.
Both SL and CentOS derive from RHEL, but [http://centfoam.sourceforge.net/wiki/index.php/Main_Page CentFOAM] is what inspired this (and other related instruction pages). Therefore, before even trying to follow the instructions on this page, try first [http://centfoam.sourceforge.net/wiki/index.php/Main_Page CentFOAM].
Last but not least, RHEL uses Fedora as their bleeding edge Linux Distribution, where they test new features. This leads to very close similarities between them, e.g. RHEL 6.3 is very similar to Fedora 14; which means that whatever you can build on Fedora 14, you should also be able to build on RHEL 6.3!
If you do not yet feel comfortable using Linux, then perhaps you better first read the page [[Installation/Working with the Shell|Working with the Shell]] and train a bit with the shell/terminal environments, so you can have a better perception of the steps shown below.
__FORCETOC__
__TOC__
= ''Copy-Paste'' steps =
A few notes before you start copy-pasting:
# Lines that start with <tt>#</tt> don't have to be ''copy-pasted''. They are just comments to let you know what's going on.
# One wrong character is enough for breaking this guide, so make sure you can read the characters properly or that the installed language system does not break the copied characters!
== CentOS 6.10 ==
Here you have the following choices:
* You can install from source, by either:
** Following the official instructions from here: [http://openfoam.org/download/source/ OpenFOAM Source Repository]
** Or by following the detailed step-by-step instructions below...
Notes regarding the instructions below:
* The instructions below were tested with CentOS 6.9, but might work with 6.6, 6.7, 6.8 or newer versions.
<span style="font-size:180%">'''WARNING: These instructions are currently being written and under testing!'''</span>
'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}
Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
<li>Install the necessary packages:
<bash>yum groupinstall 'Development Tools'
yum install zlib-devel texinfo gstreamer-plugins-base-devel \
libXext-devel libGLU-devel libXt-devel libXrender-devel libXinerama-devel libpng-devel \
libXrandr-devel libXi-devel libXft-devel libjpeg-turbo-devel libXcursor-devel \
readline-devel ncurses-devel
#This one is useful, but not crucial
yum upgrade</bash>
</li>
<li>'''Optional''': Python 2.6 that is provided in CentOS 6.x is not enough to use ParaView 5.4.0 with Python support. Therefore, either Python 2.7, 3.3 or newer has to be installed from another repository or it has to be built from source code. In these instructions we will rely on the [https://wiki.centos.org/AdditionalResources/Repositories/SCL Software Collections ( SCL ) Repository], which can be used to install software in a non-intrusive way... which will require its own environment loading mechanism. The steps to install it are as follows:
<ol>
<li>Still as root, install the aforementioned SCL repository:
<bash>yum install centos-release-SCL</bash>
</li>
<li>Then install the Python 2.7 package:
<bash>yum install python27</bash>
</li>
<li>To check if it's installed, run:
<bash>scl --list</bash>
</li>
<li>For future reference, the easiest way to activate the environment on the current command line is to run, '''but do ''not'' do this right now''':
<bash>source /opt/rh/python27/enable</bash>
This command will be indicated to be executed at the right point in the instructions below.
</li>
</ol>
</li>
{{Installation/Linux/ExitRoot}}
<li>Start a new terminal. This is because you'll need a fully refreshed shell.</li>
<li>Download and unpack (here you can copy-paste all in single go):
<bash>#OpenFOAM downloading and installation
cd ~
mkdir OpenFOAM
cd OpenFOAM
git clone https://github.com/OpenFOAM/OpenFOAM-6.git
git clone https://github.com/OpenFOAM/ThirdParty-6.git
</bash>
But we will now have to download a few more of the necessary packages for the {{tt|ThirdParty-6}} folder:
<ol>
<li>First, we need to prepare for the downloads:
<bash>cd ThirdParty-6
mkdir download
</bash>
</li>
<li>Now, we need to download the essential source code packages for these instructions you are following (the links are from the file {{tt|README.org}}):
<bash>wget -P download https://www.cmake.org/files/v3.9/cmake-3.9.0.tar.gz
wget -P download https://github.com/CGAL/cgal/releases/download/releases%2FCGAL-4.10/CGAL-4.10.tar.xz
wget -P download https://sourceforge.net/projects/boost/files/boost/1.55.0/boost_1_55_0.tar.bz2
wget -P download https://www.open-mpi.org/software/ompi/v2.1/downloads/openmpi-2.1.1.tar.bz2
wget -P download http://www.paraview.org/files/v5.4/ParaView-v5.4.0.tar.gz
</bash>
</li>
<li>Next, we need to unpack the packages we've downloaded:
<bash>tar -xzf download/cmake-3.9.0.tar.gz
tar -xJf download/CGAL-4.10.tar.xz
tar -xjf download/boost_1_55_0.tar.bz2
tar -xjf download/openmpi-2.1.1.tar.bz2
tar -xzf download/ParaView-v5.4.0.tar.gz --transform='s/ParaView-v5.4.0/ParaView-5.4.0/'
</bash>
</li>
<li>Last but not least, the final command on this sub-list is to go back to the main {{tt|OpenFOAM}} folder:
<bash>cd ..
</bash>
</li>
</ol>
</li>
<li>A few details need to be fixed, before proceeding, which will change the default Boost and CGAL versions:
<bash>sed -i -e 's/\(boost_version=\)boost-system/\1boost_1_55_0/' OpenFOAM-6/etc/config.sh/CGAL
sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.10/' OpenFOAM-6/etc/config.sh/CGAL
</bash>
</li>
<li>For building OpenFOAM itself, it depends on whether you have installed the i386 or x86_64 architecture of CentOS/SL/RHEL. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i386:
<bash>source $HOME/OpenFOAM/OpenFOAM-6/etc/bashrc WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_ARCH_OPTION=32 WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes
</bash>
Also, save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of6='source \$HOME/OpenFOAM/OpenFOAM-6/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM 6|of6}}
</li>
<li>For x86_64, it depends on whether you need 64-bit integer support or not. Depending on whether you need 64-bit integer support or not:
<ul {{NoIndentStyle}}>
<li>For building with the normal 32-bit integer support (maximum 2.147×10<sup>9</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-6/etc/bashrc WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes
</bash>
</li>
<li>For building with the normal 64-bit integer support (maximum 9.22×10<sup>18</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-6/etc/bashrc WM_LABEL_SIZE=64 WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes
</bash>
</li>
</ul>
Also, save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of6='source \$HOME/OpenFOAM/OpenFOAM-6/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM 6|of6}}
</li>
</ul>
Note: You probably will see a message similar to this one and it's meant to do so until we've built the custom Gcc version:
<bash>Warning in /home/user/OpenFOAM/OpenFOAM-6/etc/config/settings.sh:
Cannot find /home/user/OpenFOAM/ThirdParty-6/platforms/linux64/gcc-4.8.5 installation.
Please install this compiler version or if you wish to use the system compiler,
change the 'WM_COMPILER_TYPE' setting to 'system'</bash>
</li>
<li>Now we'll have to get all of the scripts we'll need to build GCC and binutils (because OpenFOAM-6 requires at least GCC 4.8 and CentOS only provides GCC 4.4):
<bash>cd $WM_THIRD_PARTY_DIR
wget "https://raw.github.com/wyldckat/scripts4OpenFOAM3rdParty/master/getGcc"
wget "https://raw.github.com/wyldckat/ThirdParty-2.0.x/binutils/makeBinutils"
wget "https://raw.github.com/wyldckat/ThirdParty-2.0.x/binutils/getBinutils"
chmod +x get* make*
</bash>
</li>
<li>CentOS 6.x comes with CMake 2.6.4, but ParaView 5.4.0 needs a one of the versions from the more recent CMake 3.x series and CGAL also needs CMake. Therefore, we'll need to do a custom build and we have to do it before we build the custom GCC+binutils (reason: [http://www.cfd-online.com/Forums/openfoam-installation/130205-paraview-4-redhat-possible.html#post478025]):
<bash>cd $WM_THIRD_PARTY_DIR
./makeCmake > log.makeCmake 2>&1
wmRefresh
</bash>
<ul {{NoIndentStyle}}>
<li>'''Note:''' If you've already tried building CMake and got this error message:
<bash>note: 'keypad' is defined in DSO /lib64/libtinfo.so.5 so try adding it to the linker command line</bash>
Then run:
<bash>mv $WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_ARCH_OPTION/gcc-4.8.5 $WM_THIRD_PARTY_DIR/platforms/linux64/gcc-4.8.5.bak
./makeCmake > log.makeCmake 2>&1
mv $WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_ARCH_OPTION/gcc-4.8.5.bak $WM_THIRD_PARTY_DIR/platforms/linux64/gcc-4.8.5
wmRefresh
</bash>
</li>
</ul>
</li>
<li>Now let's get and build Gcc 4.8.5 and company:
<bash>./getGcc gcc-4.8.5 gmp-5.1.2 mpfr-3.1.2 mpc-1.0.1
./makeGcc -no-multilib > log.makeGcc 2>&1
wmRefresh</bash>
If it still gives you the same error message from #3, then something went wrong...
</li>
<li>Now let's get and build a custom GNU Binutils:
<bash>./getBinutils
./makeBinutils gcc-4.8.5 > log.makeBinutils 2>&1</bash>
</li>
<li>Now let's build CGAL, because we need to use custom options and we need the shell environment to be updated afterwards, for CGAL to be properly picked up for building OpenFOAM:
<bash># This next command will take a little while...
./makeCGAL > log.makeCGAL 2>&1
#update the shell environment
wmRefresh
</bash>
</li>
<li>CentOS 6.x comes with Qt 4.6.2, but ParaView 5.4.0 needs at least 4.7. Therefore, we'll need to do a custom build of Qt 4.8.6:
<bash>cd $WM_THIRD_PARTY_DIR
#Get the scripts we need
wget https://github.com/wyldckat/scripts4OpenFOAM3rdParty/raw/master/getQt
wget https://github.com/OpenFOAM/ThirdParty-2.4.x/raw/master/makeQt
wget -P etc/tools/ https://github.com/OpenFOAM/ThirdParty-2.4.x/raw/master/etc/tools/QtFunctions
#make them executable
chmod +x getQt makeQt
#define correct download version and download it
sed -i -e 's=4\.6=4.8=' -e 's=4\.8\.4=4.8.6=' -e 's=/\$major/\$tarFile=/$major/$version/$tarFile=' getQt
./getQt
./makeQt qt-4.8.6 > log.makeQt 2>&1</bash></li>
<li>Given that a custom Open-MPI version is being built with these instructions, it's necessary to first build it before ParaView so that Open-MPI can be used by ParaView:
<bash>cd $WM_THIRD_PARTY_DIR
./Allwmake > log.make 2>&1
wmRefresh
</bash>
</li>
<li>For building ParaView 5.4.0 with Python and MPI, it depends on whether you have installed the i686 or x86_64 architecture of CentOS 6.:
<ol>
<li>To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>cd $WM_THIRD_PARTY_DIR
# Load the Python 2.7 that came with the SCL repository
source /opt/rh/python27/enable
#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -qt-4.8.6 -mpi -python -python-lib /opt/rh/python27/root/usr/lib/libpython2.7.so -python-include /opt/rh/python27/root/usr/include/python2.7 > log.makePV 2>&1
</bash>
'''Note:''' If the SCL repository is not being used when following these instructions, then run the last line like this:
<bash>./makeParaView -qt-4.8.6 -mpi > log.makePV 2>&1
</bash>
</li>
<li>For x86_64:
<bash>cd $WM_THIRD_PARTY_DIR
# Load the Python 2.7 that came with the SCL repository
source /opt/rh/python27/enable
#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -qt-4.8.6 -mpi -python -python-lib /opt/rh/python27/root/usr/lib64/libpython2.7.so -python-include /opt/rh/python27/root/usr/include/python2.7 > log.makePV 2>&1
</bash>
'''Note:''' If the SCL repository is not being used when following these instructions, then run the last line like this:
<bash>./makeParaView -qt-4.8.6 -mpi > log.makePV 2>&1
</bash>
</li>
</ul>
</li>
<li>{{Installation/ParaView/BuildProblemsCheckFAQ|makeParaView|log.makePV}}
</li>
<li>Finally, update the shell environment:
<bash>wmRefresh</bash>
</li>
</ol>
</li>
<li>Now let's build OpenFOAM:
<ol>
<li>Go into OpenFOAM's main source folder:
<bash>cd $WM_PROJECT_DIR</bash>
</li>
<li>We need to temporarily populate {{tt|CMAKE_PREFIX_PATH}} with the path to the custom Qt build, so that {{tt|qmake}} is properly found when building OpenFOAM's plug-in libraries for ParaView:
<bash>export CMAKE_PREFIX_PATH=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER/qt-4.8.6/</bash>
</li>
<li>This next command will take a while... somewhere between 30 minutes to 3-6 hours:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
{{Installation/Linux/NumberOfCores}}
</li>
<li>Run it a second time for getting a summary of the installation:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
'''Note:''' Technically, the build will stop as soon as the first error is found. Running a second time only makes it easier to sort through between what's already been built and where the crash occurred.
</li>
</ol>
</li>
<li>{{Installation/Linux/CheckIfAllWentWell}}</li>
<li>Now you can go read the User Guide: [http://openfoam.org/docs/user/ official OpenFOAM User Guide]</li>
<li>'''Note''': When you want to update your build, follow the instructions on section [[Installation/Linux/OpenFOAM-6#Steps for updating|Steps for updating]] on the parent page.</li>
</ol>
{{Installation/Linux/AliasReminder|OpenFOAM 6|of6}}
'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}
<br>
== CentOS 7.4 (1708) ==
Here you have the following choices:
* You can install from source, by either:
** Following the official instructions from here: [http://openfoam.org/download/source/ OpenFOAM Source Repository]
** Or by following the detailed step-by-step instructions below...
Notes regarding the instructions below:
* The instructions below were tested with CentOS 7.4, but might work with older 7.0-7.3 or with newer 7.x versions.
* There is no support for the 32-bit architectures in CentOS 7, therefore these instructions only address the x86_64 architecture.
<span style="font-size:180%">'''WARNING: These instructions are currently being written and under testing!'''</span>
'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}
Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
<li>Install the necessary packages:
<bash>yum groupinstall 'Development Tools'
yum install zlib-devel libXext-devel libGLU-devel libXt-devel libXrender-devel libXinerama-devel \
libpng-devel libXrandr-devel libXi-devel libXft-devel libjpeg-turbo-devel libXcursor-devel \
readline-devel ncurses-devel python python-devel cmake qt-devel qt-assistant \
mpfr-devel gmp-devel
#This one is useful, but not crucial
yum upgrade</bash>
</li>
{{Installation/Linux/ExitRoot}}
<li>Start a new terminal. This is because you'll need a fully refreshed shell.</li>
<li>Download and unpack (here you can copy-paste all in single go):
<bash>#OpenFOAM downloading and installation
cd ~
mkdir OpenFOAM
cd OpenFOAM
git clone https://github.com/OpenFOAM/OpenFOAM-6.git
git clone https://github.com/OpenFOAM/ThirdParty-6.git
</bash>
But we will now have to download a few more of the necessary packages for the {{tt|ThirdParty-6}} folder:
<ol>
<li>First, we need to prepare for the downloads:
<bash>cd ThirdParty-6
mkdir download
</bash>
</li>
<li>Now, we need to download the essential source code packages for these instructions you are following (the links are from the file {{tt|README.org}}):
<bash>wget -P download https://www.cmake.org/files/v3.9/cmake-3.9.0.tar.gz
wget -P download https://github.com/CGAL/cgal/releases/download/releases%2FCGAL-4.10/CGAL-4.10.tar.xz
wget -P download https://sourceforge.net/projects/boost/files/boost/1.55.0/boost_1_55_0.tar.bz2
wget -P download https://www.open-mpi.org/software/ompi/v2.1/downloads/openmpi-2.1.1.tar.bz2
wget -P download http://www.paraview.org/files/v5.4/ParaView-v5.4.0.tar.gz
</bash>
</li>
<li>Next, we need to unpack the packages we've downloaded:
<bash>tar -xzf download/cmake-3.9.0.tar.gz
tar -xJf download/CGAL-4.10.tar.xz
tar -xjf download/boost_1_55_0.tar.bz2
tar -xjf download/openmpi-2.1.1.tar.bz2
tar -xzf download/ParaView-v5.4.0.tar.gz --transform='s/ParaView-v5.4.0/ParaView-5.4.0/'
</bash>
</li>
<li>Last but not least, the final command on this sub-list is to go back to the main {{tt|OpenFOAM}} folder:
<bash>cd ..
</bash>
</li>
</ol>
</li>
<li>A few details need to be fixed, before proceeding, which will change the default Boost and CGAL versions:
<bash>sed -i -e 's/\(boost_version=\)boost-system/\1boost_1_55_0/' OpenFOAM-6/etc/config.sh/CGAL
sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.10/' OpenFOAM-6/etc/config.sh/CGAL
</bash>
</li>
<li>For building OpenFOAM itself, first we need to activate the correct environment settings and it depends on whether you need 64-bit integer support or not. Depending on whether you need 64-bit integer support or not:
<ul {{NoIndentStyle}}>
<li>For building with the normal 32-bit integer support (maximum 2.147×10<sup>9</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-6/etc/bashrc WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes
</bash>
</li>
<li>For building with the normal 64-bit integer support (maximum 9.22×10<sup>18</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-6/etc/bashrc WM_LABEL_SIZE=64 WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes
</bash>
</li>
</ul>
Also, save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of6='source \$HOME/OpenFOAM/OpenFOAM-6/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM 6|of6}}
</li>
<li>CentOS 7.4 comes with CMake 2.8.12.1, but ParaView 5.4.0 needs a one of the versions from the more recent CMake 3.x series and CGAL also needs CMake. Therefore, we'll need to do a custom build by running:
<bash>cd $WM_THIRD_PARTY_DIR
./makeCmake > log.makeCmake 2>&1
wmRefresh
</bash>
</li>
<li>Given that a custom Open-MPI version is being built with these instructions, it's necessary to first build it before ParaView so that Open-MPI can be used by ParaView:
<bash>cd $WM_THIRD_PARTY_DIR
./Allwmake > log.make 2>&1
wmRefresh
</bash>
</li>
<li>For building ParaView 5.4.0 with Python and MPI, do the following steps:
<ol>
<li>Build by running these commands:
<bash>cd $WM_THIRD_PARTY_DIR
#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -mpi -python -qmake $(which qmake-qt4) > log.makePV 2>&1
</bash>
</li>
<li>{{Installation/ParaView/BuildProblemsCheckFAQ|makeParaView|log.makePV}}
</li>
<li>Finally, update the shell environment:
<bash>wmRefresh</bash>
</li>
</ol>
</li>
<li>Now let's build OpenFOAM:
<ol>
<li>Go into OpenFOAM's main source folder:
<bash>cd $WM_PROJECT_DIR</bash>
</li>
<li>This next command will take a while... somewhere between 30 minutes to 3-6 hours:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
{{Installation/Linux/NumberOfCores}}
</li>
<li>Run it a second time for getting a summary of the installation:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
'''Note:''' Technically, the build will stop as soon as the first error is found. Running a second time only makes it easier to sort through between what's already been built and where the crash occurred.
</li>
</ol>
</li>
<li>{{Installation/Linux/CheckIfAllWentWell}}</li>
<li>Now you can go read the User Guide: [http://openfoam.org/docs/user/ official OpenFOAM User Guide]</li>
<li>'''Note''': When you want to update your build, follow the instructions on section [[Installation/Linux/OpenFOAM-6#Steps for updating|Steps for updating]] on the parent page.</li>
</ol>
{{Installation/Linux/AliasReminder|OpenFOAM 6|of6}}
'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}
<br>
[[Category:Installing OpenFOAM on Linux]] [[Category:Installing OpenFOAM on CentOS]]
