View source for Installation/Linux/OpenFOAM-5.x/Ubuntu

= Introduction =
This page is dedicated to explaining how to install {{OpenFOAM}} {{version5.x}} in [http://www.ubuntu.com Ubuntu].

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!

== Ubuntu 12.04 ==

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...


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install git-core build-essential flex bison zlib1g-dev qt4-dev-tools libqt4-dev gnuplot libreadline-dev \
libncurses-dev libxt-dev python python-dev
</bash>
'''Note''': It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:
<bash>apt-get install libglu1-mesa-dev libqt4-opengl-dev</bash>
</li>

{{Installation/Linux/ExitRoot}}

<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-5.x.git
git clone https://github.com/OpenFOAM/ThirdParty-5.x.git
</bash>
But we will now have to download a few more of the necessary packages for the {{tt|ThirdParty-5.x}} folder:
<ol>
<li>First, we need to prepare for the downloads:
<bash>cd ThirdParty-5.x
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>'''Optional''': Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
<bash>ln -s /usr/bin/mpicc.openmpi OpenFOAM-5.x/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-5.x/bin/mpirun</bash>
This way we avoid having problems in case there is more than one MPI toolbox installed in your Ubuntu system, for example if MPICH2 is installed and is the default MPI toolbox.
</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-5.x/etc/config.sh/CGAL
sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.10/' OpenFOAM-5.x/etc/config.sh/CGAL
</bash>
</li>

<li>For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_MPLIB=OPENMPI WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
</bash></li>

<li>For x86_64, it depends 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-5.x/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-5.x/etc/bashrc WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_MPLIB=OPENMPI WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
</bash>
</li>
</ul>
</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-5.x/etc/config/settings.sh:
    Cannot find /home/user/OpenFOAM/ThirdParty-5.x/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>Save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of5x='source \$HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM-5.x|of5x}}
</li>

<li>Ubuntu 12.04 comes with CMake 2.8.7, but ParaView 5.4.0 needs CMake 3.x or newer series and CGAL also needs CMake. Therefore, we'll need to do a custom build:
<bash>cd $WM_THIRD_PARTY_DIR
./makeCmake > log.makeCM 2>&1
wmRefresh
</bash>
</li>

<li>Now we'll have to get all of the scripts we'll need to build GCC and binutils (because OpenFOAM-5.x requires at least GCC 4.8 and Ubuntu 12.04 only provides GCC 4.7):
<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>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 the {{tt|ThirdParty}} folder, because we need the shell environment to be updated afterwards, for Open-MPI to be properly picked up for building ParaVeiw with MPI support:
<bash>cd $WM_THIRD_PARTY_DIR

# This next command will take a while... somewhere between 5 minutes to 30 minutes.
./Allwmake > log.make 2>&1

#update the shell environment
wmRefresh
</bash>
</li>

<li>Now, in order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
<ol>
<li>For building ParaView with Python and MPI, run:
<bash>cd $WM_THIRD_PARTY_DIR

#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/libpython2.7.so.1.0 > 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>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>

<li>When you need to update your local ''clone'', for getting the latest source code updates, you can follow the instructions provided in the page [[Installation/Working with git repositories]].</li>

<li>'''Note''': When you want to update your build, follow the instructions on section [[Installation/Linux/OpenFOAM-5.x#Steps for updating|Steps for updating]] on the parent page.</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM-5.x|of5x}}


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

== Ubuntu 14.04 ==

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...


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install git-core build-essential binutils-dev cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev libqtwebkit-dev gnuplot \
libreadline-dev libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev \
libmpfr-dev python python-dev
</bash>
'''Note''': It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:
<bash>apt-get install libglu1-mesa-dev libqt4-opengl-dev</bash>
</li>

{{Installation/Linux/ExitRoot}}

<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-5.x.git
git clone https://github.com/OpenFOAM/ThirdParty-5.x.git
</bash>
But we will now have to download a few more of the necessary packages for the {{tt|ThirdParty-5.x}} folder:
<ol>
<li>First, we need to prepare for the downloads:
<bash>cd ThirdParty-5.x
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://github.com/CGAL/cgal/releases/download/releases/CGAL-4.10/CGAL-4.10.tar.xz
wget -P download http://www.cmake.org/files/v3.9/cmake-3.9.0.tar.gz
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 -xJf download/CGAL-4.10.tar.xz
tar -xzf download/cmake-3.9.0.tar.gz
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>'''Optional''': Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
<bash>ln -s /usr/bin/mpicc.openmpi OpenFOAM-5.x/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-5.x/bin/mpirun</bash>
This way we avoid having problems in case there is more than one MPI toolbox installed in your Ubuntu system, for example if MPICH2 is installed and is the default MPI toolbox.
</li>

<li>A few details need to be fixed, before proceeding, which will change the default CGAL version:
<bash>sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.10/' OpenFOAM-5.x/etc/config.sh/CGAL
</bash>
</li>

<li>For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
</bash></li>

<li>For x86_64, it depends 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-5.x/etc/bashrc 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-5.x/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
</bash>
</li>
</ul>
</li>
</ul>
</li>

<li>Save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of5x='source \$HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM-5.x|of5x}}
</li>

<li>Ubuntu 14.04 comes with CMake 2.8.12.2, but ParaView 5.4.0 needs CMake 3.5 or newer series and CGAL also needs CMake. Therefore, we'll need to do a custom build:
<bash>cd $WM_THIRD_PARTY_DIR
./makeCmake > log.makeCM 2>&1
wmRefresh
</bash></li>

<li>Now let's build the {{tt|ThirdParty}} folder, because we need the shell environment to be updated afterwards, for CGAL to be properly picked up for building OpenFOAM:
<bash>cd $WM_THIRD_PARTY_DIR

#make very certain that the correct Qt version is being used, by running this command:
export QT_SELECT=qt4

# This next command will take a while... somewhere between 5 minutes to 30 minutes.
./Allwmake > log.make 2>&1

#update the shell environment
wmRefresh
</bash>
</li>

<li>Now, in order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
<ol>
<li>Make sure you're running in the {{tt|ThirdParty}} folder and that the correct Qt version is used:
<bash>cd $WM_THIRD_PARTY_DIR
export QT_SELECT=qt4
 </bash>
</li>
<li>For building ParaView with Python and MPI, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/i386-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>

<li>For x86_64:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0 > 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 and be certain that the correct Qt version is being used:
<bash>cd $WM_PROJECT_DIR
export QT_SELECT=qt4</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>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>

<li>When you need to update your local ''clone'', for getting the latest source code updates, you can follow the instructions provided in the page [[Installation/Working with git repositories]].</li>

<li>'''Note''': When you want to update your build, follow the instructions on section [[Installation/Linux/OpenFOAM-5.x#Steps for updating|Steps for updating]] on the parent page.</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM-5.x|of5x}}


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

== Ubuntu 16.04 ==

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]
** If you're looking for semi-automatic installation instructions, try [[Installation/Ansible]].
** Or by following the detailed step-by-step instructions below...


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install git-core build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev libqtwebkit-dev gnuplot \
libreadline-dev libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev \
libmpfr-dev python python-dev libcgal-dev curl
</bash>
'''Note''': It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:
<bash>apt-get install libglu1-mesa-dev libqt4-opengl-dev</bash>
</li>

{{Installation/Linux/ExitRoot}}

<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-5.x.git
git clone https://github.com/OpenFOAM/ThirdParty-5.x.git
</bash>
</li>

<li>'''Optional''': Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
<bash>ln -s /usr/bin/mpicc.openmpi OpenFOAM-5.x/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-5.x/bin/mpirun</bash>
This way we avoid having problems in case there is more than one MPI toolbox installed in your Ubuntu system, for example if MPICH2 is installed and is the default MPI toolbox.
</li>

<li>For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
</bash></li>

<li>For x86_64, it depends 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-5.x/etc/bashrc 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-5.x/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
</bash>
</li>
</ul>
</li>
</ul>
</li>

<li>Save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of5x='source \$HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM-5.x|of5x}}
</li>

<li>In order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
<ol>
<li>Make sure you're running in the {{tt|ThirdParty}} folder and that the correct Qt version is used:
<bash>cd $WM_THIRD_PARTY_DIR
export QT_SELECT=qt4
 </bash>
</li>
<li>For building ParaView with Python and MPI, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/i386-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>

<li>For x86_64:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0 > 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 and be certain that the correct Qt version is being used:
<bash>cd $WM_PROJECT_DIR
export QT_SELECT=qt4</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>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>

<li>When you need to update your local ''clone'', for getting the latest source code updates, you can follow the instructions provided in the page [[Installation/Working with git repositories]].</li>

<li>'''Note''': When you want to update your build, follow the instructions on section [[Installation/Linux/OpenFOAM-5.x#Steps for updating|Steps for updating]] on the parent page.</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM-5.x|of5x}}


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

== Ubuntu 18.04 ==

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...


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install git-core build-essential cmake libfl-dev bison zlib1g-dev qt4-dev-tools libqt4-dev libqtwebkit-dev gnuplot \
libreadline-dev libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev \
libmpfr-dev python python-dev libcgal-dev curl
</bash>
'''Note''': It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:
<bash>apt-get install libglu1-mesa-dev libqt4-opengl-dev</bash>
</li>

{{Installation/Linux/ExitRoot}}

<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-5.x.git
git clone https://github.com/OpenFOAM/ThirdParty-5.x.git
</bash>
</li>

<li>'''Optional''': Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
<bash>ln -s /usr/bin/mpicc.openmpi OpenFOAM-5.x/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-5.x/bin/mpirun</bash>
This way we avoid having problems in case there is more than one MPI toolbox installed in your Ubuntu system, for example if MPICH2 is installed and is the default MPI toolbox.
</li>

<li>For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
</bash></li>

<li>For x86_64, it depends 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-5.x/etc/bashrc 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-5.x/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
</bash>
</li>
</ul>
</li>
</ul>
</li>

<li>Save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of5x='source \$HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM-5.x|of5x}}
</li>

<li>In order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
<ol>
<li>Make sure you're running in the {{tt|ThirdParty}} folder and that the correct Qt version is used:
<bash>cd $WM_THIRD_PARTY_DIR
export QT_SELECT=qt4
 </bash>
</li>
<li>For building ParaView with Python and MPI, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/i386-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>

<li>For x86_64:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0 > 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 and be certain that the correct Qt version is being used:
<bash>cd $WM_PROJECT_DIR
export QT_SELECT=qt4</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>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>

<li>When you need to update your local ''clone'', for getting the latest source code updates, you can follow the instructions provided in the page [[Installation/Working with git repositories]].</li>

<li>'''Note''': When you want to update your build, follow the instructions on section [[Installation/Linux/OpenFOAM-5.x#Steps for updating|Steps for updating]] on the parent page.</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM-5.x|of5x}}


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}



[[Category:Installing OpenFOAM on Linux]] [[Category:Installing OpenFOAM on Ubuntu]]