View source for Installation/Linux/OpenFOAM-2.3.1/Ubuntu

= Introduction =
This page is dedicated to explaining how to install {{OpenFOAM}} {{version2.3.1}} 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 at least two choices:
* You can install from source, by either:
** Following the official instructions from here: [http://openfoam.org/download/2-3-1-source/ Download v2.3.1 | Source Pack]
** Or by following the detailed step-by-step instructions below...


'''Discussion thread where you can ask questions about these steps''': [http://www.cfd-online.com/Forums/openfoam-installation/149765-problems-installing-openfoam-2-3-1-ubuntu-12-04-a.html Problems installing OpenFOAM 2.3.1 in Ubuntu 12.04]

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev gnuplot libreadline-dev \
libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev libmpfr-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
wget "http://downloads.sourceforge.net/foam/OpenFOAM-2.3.1.tgz?use_mirror=mesh" -O OpenFOAM-2.3.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.3.1.tgz?use_mirror=mesh" -O ThirdParty-2.3.1.tgz

tar -xzf OpenFOAM-2.3.1.tgz 
tar -xzf ThirdParty-2.3.1.tgz 
</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-2.3.1/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.3.1/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>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32
</bash></li>

<li>For x86_64:
<bash>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI
</bash>
</li>
</ul>
</li>

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

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

#update the shell environment
wmSET $FOAM_SETTINGS
</bash>
</li>

<li>Ubuntu 12.04 comes with CMake 2.8.7, but ParaView 4.1.0 needs CMake 2.8.8 or newer series. Therefore, we'll need to do a custom build:
<bash>cd $WM_THIRD_PARTY_DIR
wget "https://raw.github.com/wyldckat/scripts4OpenFOAM3rdParty/master/getCmake"
sed -i -e 's=version}\.3=version}.12.1=' getCmake
chmod +x getCmake
./getCmake
./makeCmake
wmSET $FOAM_SETTINGS
</bash></li>

<li>Now, in order to build ParaView 4.1.0 that comes with OpenFOAM:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView4 -qmake $(which qmake-qt4) > log.makePV 2>&1

#update the shell environment
wmSET $FOAM_SETTINGS
</bash>
Once the {{tt|makeParaView4}} scripts is finished running, make sure to check the contents of the file {{tt|log.makePV}} and check if there are any errors.</li>

<li>Now let's build OpenFOAM:<br>
('''Warning''': this may take somewhere from 30 minutes to 6 hours, depending on your machine.)<br>
<bash>#Go into OpenFOAM's main source folder
cd $WM_PROJECT_DIR

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

#Run it a second time for getting a summary of the installation
./Allwmake > log.make 2>&1
</bash></li>

<li>{{Installation/Linux/CheckIfAllWentWell}}</li>

<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM 2.3.1|of231}}


'''Discussion thread where you can ask questions about these steps''': [http://www.cfd-online.com/Forums/openfoam-installation/149765-problems-installing-openfoam-2-3-1-ubuntu-12-04-a.html Problems installing OpenFOAM 2.3.1 in Ubuntu 12.04]

== Ubuntu 13.10 ==

Here you have at least two choices:
* You can install from source, by either:
** Following the official instructions from here: [http://openfoam.org/download/2-3-1-source/ Download v2.3.1 | Source Pack]
** 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 build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev gnuplot libreadline-dev \
libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev libmpfr-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
wget "http://downloads.sourceforge.net/foam/OpenFOAM-2.3.1.tgz?use_mirror=mesh" -O OpenFOAM-2.3.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.3.1.tgz?use_mirror=mesh" -O ThirdParty-2.3.1.tgz

tar -xzf OpenFOAM-2.3.1.tgz 
tar -xzf ThirdParty-2.3.1.tgz 
</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-2.3.1/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.3.1/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>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32
</bash></li>

<li>For x86_64:
<bash>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI
</bash>
</li>
</ul>
</li>

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

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

#update the shell environment
wmSET $FOAM_SETTINGS
</bash>
</li>

<li>Now, in order to build ParaView 4.1.0 that comes with OpenFOAM:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView4 -qmake $(which qmake-qt4) > log.makePV 2>&1

#update the shell environment
wmSET $FOAM_SETTINGS
</bash>
Once the {{tt|makeParaView4}} scripts is finished running, make sure to check the contents of the file {{tt|log.makePV}} and check if there are any errors.</li>

<li>Now let's build OpenFOAM:<br>
('''Warning''': this may take somewhere from 30 minutes to 6 hours, depending on your machine.)<br>
<bash>#Go into OpenFOAM's main source folder
cd $WM_PROJECT_DIR

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

#Run it a second time for getting a summary of the installation
./Allwmake > log.make 2>&1
</bash></li>

<li>{{Installation/Linux/CheckIfAllWentWell}}</li>

<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM 2.3.1|of231}}


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


== Ubuntu 14.04 ==

Here you have the following choices:
* You can install the Deb packages, which provide a quick and easy way for having a working installation of OpenFOAM 2.3.1. This is the quickest solution for beginners and instructions are provided here: [http://openfoam.org/download/2-3-1-ubuntu/ Download v2.3.1 | Ubuntu]
** Note: If are getting an error when trying to install the packages for Ubuntu, then check this FAQ: [[FAQ/Installation and Running#Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?|Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?]]
* You can install from source, by either:
** Following the official instructions from here: [http://openfoam.org/download/2-3-1-source/ Download v2.3.1 | Source Pack]
** Or by following the detailed step-by-step instructions below...

'''Discussion thread where you can ask questions about these steps''': [http://www.cfd-online.com/Forums/openfoam-installation/136504-paraview-not-found-when-installing-openfoam-ubuntu-14-04-a.html Paraview not found when installing OpenFoam to Ubuntu 14.04]

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install 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
</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
wget "http://downloads.sourceforge.net/foam/OpenFOAM-2.3.1.tgz?use_mirror=mesh" -O OpenFOAM-2.3.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.3.1.tgz?use_mirror=mesh" -O ThirdParty-2.3.1.tgz

tar -xzf OpenFOAM-2.3.1.tgz 
tar -xzf ThirdParty-2.3.1.tgz 
</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-2.3.1/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.3.1/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>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32
</bash></li>

<li>For x86_64:
<bash>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI
</bash>
</li>
</ul>
</li>

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

<li>Now, in order to build ParaView 4.1.0 that comes with OpenFOAM:
<bash>#First make very certain that the correct Qt version is being used, by running this command:
export QT_SELECT=qt4

#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView4 > log.makePV 2>&1

#update the shell environment
wmSET $FOAM_SETTINGS
</bash>
Once the {{tt|makeParaView4}} scripts is finished running, make sure to check the contents of the file {{tt|log.makePV}} and check if there are any errors.</li>

<li>Now let's build OpenFOAM:<br>
('''Warning''': this may take somewhere from 30 minutes to 6 hours, depending on your machine.)<br>
<bash>#Go into OpenFOAM's main source folder
cd $WM_PROJECT_DIR

#Still better be certain that the correct Qt version is being used
export QT_SELECT=qt4

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

#Run it a second time for getting a summary of the installation
./Allwmake > log.make 2>&1
</bash></li>

<li>{{Installation/Linux/CheckIfAllWentWell}}</li>

<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM 2.3.1|of231}}


'''Discussion thread where you can ask questions about these steps''': [http://www.cfd-online.com/Forums/openfoam-installation/136504-paraview-not-found-when-installing-openfoam-ubuntu-14-04-a.html Paraview not found when installing OpenFoam to Ubuntu 14.04]


== Ubuntu 14.10 ==

Here you have the following choices:
* You can install the Deb packages, which provide a quick and easy way for having a working installation of OpenFOAM 2.3.1. This is the quickest solution for beginners and instructions are provided here: [http://openfoam.org/download/2-3-1-ubuntu/ Download v2.3.1 | Ubuntu]
** Note: If are getting an error when trying to install the packages for Ubuntu, then check this FAQ: [[FAQ/Installation and Running#Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?|Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?]]
* You can install from source, by either:
** Following the official instructions from here: [http://openfoam.org/download/2-3-1-source/ Download v2.3.1 | Source Pack]
** Or by following the detailed step-by-step instructions below...


'''Discussion thread where you can ask questions about these steps''': [http://www.cfd-online.com/Forums/openfoam-installation/144878-installing-openfoam-2-3-0-ubuntu-14-10-a.html Installing OpenFOAM 2.3.1 on Ubuntu 14.10]

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev libqtwebkit-dev gnuplot \
libreadline-dev libncurses5-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
wget "http://downloads.sourceforge.net/foam/OpenFOAM-2.3.1.tgz?use_mirror=mesh" -O OpenFOAM-2.3.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.3.1.tgz?use_mirror=mesh" -O ThirdParty-2.3.1.tgz

tar -xzf OpenFOAM-2.3.1.tgz 
tar -xzf ThirdParty-2.3.1.tgz 
</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-2.3.1/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.3.1/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>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32
</bash></li>

<li>For x86_64:
<bash>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI
</bash>
</li>
</ul>
</li>

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

<li>Now, in order to build ParaView 4.1.0 that comes with OpenFOAM, including with the ability to use Python and MPI, several steps are needed:
<ol>
<li>First make very certain that the correct Qt version is being used, by running this command:
<bash>export QT_SELECT=qt4</bash>
</li>
<li>Need to do several fixes:
<bash>sed -i -e 's=MPI_ARCH_PATH/include=MPI_ARCH_PATH/include;$MPI_INCLUDE=' etc/tools/ParaView4Functions

sed -i -e 's=//#define GLX_GLXEXT_LEGACY=#define GLX_GLXEXT_LEGACY=' \
  ParaView-4.1.0/VTK/Rendering/OpenGL/vtkXOpenGLRenderWindow.cxx

cd $WM_THIRD_PARTY_DIR/ParaView-4.1.0

wget http://www.paraview.org/pipermail/paraview/attachments/20140210/464496cc/attachment.bin -O Fix.patch
patch -p1 < Fix.patch

cd VTK
wget https://github.com/gladk/VTK/commit/ef22d3d69421581b33bc0cd94b647da73b61ba96.patch -O Fix2.patch
patch -p1 < Fix2.patch

cd ../..
 </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
./makeParaView4 -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
./makeParaView4 -python -mpi -python-lib /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>
</ul>
</li>
<li>Once the {{tt|makeParaView4}} script is finished running, make sure to check the contents of the file {{tt|log.makePV}} and check if there are any errors.
</li>
<li>Finally, update the shell environment:
<bash>wmSET $FOAM_SETTINGS</bash>
</li>
</ol>
</li>

<li>Now let's build OpenFOAM:<br>
('''Warning''': this may take somewhere from 30 minutes to 6 hours, depending on your machine.)<br>
<bash>#Go into OpenFOAM's main source folder
cd $WM_PROJECT_DIR

#Still better be certain that the correct Qt version is being used
export QT_SELECT=qt4

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

#Run it a second time for getting a summary of the installation
./Allwmake > log.make 2>&1
</bash></li>

<li>{{Installation/Linux/CheckIfAllWentWell}}</li>

<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM 2.3.1|of231}}


'''Discussion thread where you can ask questions about these steps''': [http://www.cfd-online.com/Forums/openfoam-installation/144878-installing-openfoam-2-3-0-ubuntu-14-10-a.html Installing OpenFOAM 2.3.1 on Ubuntu 14.10]

<br>

== Ubuntu 15.04 ==

Here you have the following choices:
* You can install from source, by either:
** Following the official instructions from here: [http://openfoam.org/download/2-3-1-source/ Download v2.3.1 | Source Pack]
** Or by following the detailed step-by-step instructions given above for [[#Ubuntu 14.10|Ubuntu 14.10]], because those instructions work just fine for Ubuntu 15.04.

<br>

== 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/2-3-1-source/ Download v2.3.1 | Source Pack]
** 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 build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev libqtwebkit-dev gnuplot \
libreadline-dev libncurses5-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev \
libmpfr-dev python python-dev libcgal-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
wget "http://downloads.sourceforge.net/foam/OpenFOAM-2.3.1.tgz?use_mirror=mesh" -O OpenFOAM-2.3.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.3.1.tgz?use_mirror=mesh" -O ThirdParty-2.3.1.tgz

tar -xzf OpenFOAM-2.3.1.tgz 
tar -xzf ThirdParty-2.3.1.tgz 
</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-2.3.1/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.3.1/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, to then use the ones provided by Ubuntu:
<bash>sed -i -e 's/\(cgal_version=\)CGAL-4.3/\1cgal-system/' OpenFOAM-2.3.1/etc/config/CGAL.sh
</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>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32
</bash></li>

<li>For x86_64:
<bash>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI
</bash>
</li>
</ul>
</li>

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

# Fix issue regarding not wanting to build CGAL
sed -i -e 's|\(^if.*CGAL_ARCH_PATH.*\)]|\1 -a "${CGAL_ARCH_PATH##*/}" != "cgal-system" ]|' Allwmake

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

#update the shell environment
wmSET $FOAM_SETTINGS
</bash>
</li>

<li>Now, in order to build ParaView 4.1.0 that comes with OpenFOAM, including with the ability to use Python and MPI, several steps are needed:
<ol>
<li>First make very certain that the correct Qt version is being used, by running this command:
<bash>export QT_SELECT=qt4</bash>
</li>
<li>Need to do several fixes:
<bash>cd $WM_THIRD_PARTY_DIR

sed -i -e 's=MPI_ARCH_PATH/include=MPI_ARCH_PATH/include;$MPI_INCLUDE=' etc/tools/ParaView4Functions

sed -i -e 's=//#define GLX_GLXEXT_LEGACY=#define GLX_GLXEXT_LEGACY=' \
  ParaView-4.1.0/VTK/Rendering/OpenGL/vtkXOpenGLRenderWindow.cxx

cd $WM_THIRD_PARTY_DIR/ParaView-4.1.0

wget http://www.paraview.org/pipermail/paraview/attachments/20140210/464496cc/attachment.bin -O Fix.patch
patch -p1 < Fix.patch

cd VTK
wget https://github.com/gladk/VTK/commit/ef22d3d69421581b33bc0cd94b647da73b61ba96.patch -O Fix2.patch
patch -p1 < Fix2.patch

cd ../..
 </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
./makeParaView4 -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
./makeParaView4 -python -mpi -python-lib /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>
</ul>
</li>
<li>Once the {{tt|makeParaView4}} script is finished running, make sure to check the contents of the file {{tt|log.makePV}} and check if there are any errors.
</li>
<li>Finally, update the shell environment:
<bash>wmSET $FOAM_SETTINGS</bash>
</li>
</ol>
</li>

<li>Now, before we can build OpenFOAM, we need to do a few fixes:
<bash>#Go into OpenFOAM's main source folder
cd $WM_PROJECT_DIR

#Change how the flex version is checked
find src applications -name "*.L" -type f | xargs sed -i -e 's=\(YY\_FLEX\_SUBMINOR\_VERSION\)=YY_FLEX_MINOR_VERSION < 6 \&\& \1='
</bash>
</li>

<li>Now let's build OpenFOAM:<br>
('''Warning''': this may take somewhere from 30 minutes to 6 hours, depending on your machine.)<br>
<bash>#Go into OpenFOAM's main source folder
cd $WM_PROJECT_DIR

#Still better be certain that the correct Qt version is being used
export QT_SELECT=qt4

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

#Run it a second time for getting a summary of the installation
./Allwmake > log.make 2>&1
</bash></li>

<li>{{Installation/Linux/CheckIfAllWentWell}}</li>

<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM 2.3.1|of231}}


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

<br>

== 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/2-3-1-source/ Download v2.3.1 | Source Pack]
** Or by following the detailed step-by-step instructions below...


'''Discussion thread where you can ask questions about these steps''': [https://www.cfd-online.com/Forums/openfoam-installation/202905-installing-openfoam-2-3-ubuntu-18-04-a.html Installing OpenFOAM 2.3 on Ubuntu 18.04]

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev libqtwebkit-dev gnuplot \
libreadline-dev libncurses5-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev \
libmpfr-dev python python-dev libcgal-dev gcc-5 g++-5
</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
wget "http://downloads.sourceforge.net/foam/OpenFOAM-2.3.1.tgz?use_mirror=mesh" -O OpenFOAM-2.3.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.3.1.tgz?use_mirror=mesh" -O ThirdParty-2.3.1.tgz

tar -xzf OpenFOAM-2.3.1.tgz 
tar -xzf ThirdParty-2.3.1.tgz 
</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-2.3.1/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.3.1/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, to then use the ones provided by Ubuntu, along with a few GCC version changes:
<bash>sed -i -e 's/\(cgal_version=\)CGAL-4.3/\1cgal-system/' OpenFOAM-2.3.1/etc/config/CGAL.sh
sed -i -e 's=\-lmpfr=-lmpfr -lboost_thread=' OpenFOAM-2.3.1/wmake/rules/General/CGAL

sed -i -e 's/gcc/\$(WM_CC)/' OpenFOAM-2.3.1/wmake/rules/linux*Gcc/c
sed -i -e 's/g++/\$(WM_CXX)/' OpenFOAM-2.3.1/wmake/rules/linux*Gcc/c++
</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>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32
export WM_CC='gcc-5'
export WM_CXX='g++-5'
</bash></li>

<li>For x86_64:
<bash>#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI
export WM_CC='gcc-5'
export WM_CXX='g++-5'
</bash>
</li>
</ul>
</li>

<li>Save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of231='source \$HOME/OpenFOAM/OpenFOAM-2.3.1/etc/bashrc $FOAM_SETTINGS; export WM_CC=gcc-5; export WM_CXX=g++-5'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM 2.3.1|of231}}
<ul  {{NoIndentStyle}}><li>Just in case, also ''source'' that file, so that you can use {{tt|of231}} in this terminal if necessary, by running:
<bash>source $HOME/.bashrc</bash>
</li></ul>
</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

# Fix issue regarding not wanting to build CGAL
sed -i -e 's|\(^if.*CGAL_ARCH_PATH.*\)]|\1 -a "${CGAL_ARCH_PATH##*/}" != "cgal-system" ]|' Allwmake

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

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

<li>Now, in order to build ParaView 4.1.0 that comes with OpenFOAM, including with the ability to use Python and MPI, several steps are needed:
<ol>
<li>First make very certain that the correct Qt version is being used, by running this command:
<bash>export QT_SELECT=qt4</bash>
</li>
<li>Need to do several fixes:
<bash>cd $WM_THIRD_PARTY_DIR

sed -i -e 's=MPI_ARCH_PATH/include=MPI_ARCH_PATH/include;$MPI_INCLUDE=' etc/tools/ParaView4Functions

sed -i -e 's=//#define GLX_GLXEXT_LEGACY=#define GLX_GLXEXT_LEGACY=' \
  ParaView-4.1.0/VTK/Rendering/OpenGL/vtkXOpenGLRenderWindow.cxx

cd $WM_THIRD_PARTY_DIR/ParaView-4.1.0

wget http://www.paraview.org/pipermail/paraview/attachments/20140210/464496cc/attachment.bin -O Fix.patch
patch -p1 < Fix.patch

cd VTK
wget https://github.com/gladk/VTK/commit/ef22d3d69421581b33bc0cd94b647da73b61ba96.patch -O Fix2.patch
patch -p1 < Fix2.patch

cd ../..
 </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
./makeParaView4 -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
./makeParaView4 -python -mpi -python-lib /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>
</ul>
</li>
<li>Once the {{tt|makeParaView4}} script is finished running, make sure to check the contents of the file {{tt|log.makePV}} and check if there are any errors.
</li>
<li>Finally, update the shell environment:
<bash>of231</bash>
</li>
</ol>
</li>

<li>Now, before we can build OpenFOAM, we need to do a few fixes:
<bash>#Go into OpenFOAM's main source folder
cd $WM_PROJECT_DIR

#Change how the flex version is checked
find src applications -name "*.L" -type f | xargs sed -i -e 's=\(YY\_FLEX\_SUBMINOR\_VERSION\)=YY_FLEX_MINOR_VERSION < 6 \&\& \1='
</bash>
</li>

<li>Now let's build OpenFOAM:<br>
('''Warning''': this may take somewhere from 30 minutes to 6 hours, depending on your machine.)<br>
<bash>#Go into OpenFOAM's main source folder
cd $WM_PROJECT_DIR

#Still better be certain that the correct Qt version is being used
export QT_SELECT=qt4

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

#Run it a second time for getting a summary of the installation
./Allwmake > log.make 2>&1
</bash></li>

<li>{{Installation/Linux/CheckIfAllWentWell}}</li>

<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM 2.3.1|of231}}


'''Discussion thread where you can ask questions about these steps''': [https://www.cfd-online.com/Forums/openfoam-installation/202905-installing-openfoam-2-3-ubuntu-18-04-a.html Installing OpenFOAM 2.3 on Ubuntu 18.04]

<br>

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