1 Introduction

This page is dedicated to explaining how to install OpenFOAM in Ubuntu.

If you do not yet feel comfortable using Linux, then perhaps you better first read the page 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.

2 Copy-Paste steps

A few notes before you start copy-pasting:

Lines that start with # 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!

2.1 Ubuntu 12.04

Here you have the following choices:

You can install from source, by either:
- Following the official instructions from here: OpenFOAM Source Repository
- Or by following the detailed step-by-step instructions below...

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

Steps:

Switch to root mode (administrator), to install the necessary packages:
```
sudo -s
```
- If the 'sudo' command tells you're not in the sudoers list, then run:
```
su -
```
Update the apt-get cache by running:
```
apt-get update
```

Install the necessary packages:

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

Note: It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:

apt-get install libglu1-mesa-dev libqt4-opengl-dev

Now exit from the root mode:
```
exit
```

Download and unpack (here you can copy-paste all in single go):

#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

But we will now have to download a few more of the necessary packages for the ThirdParty-5.x folder:

First, we need to prepare for the downloads:
```
cd ThirdParty-5.x
mkdir download
```

Now, we need to download the essential source code packages for these instructions you are following (the links are from the file README.org):

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

Next, we need to unpack the packages we've downloaded:

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/'

Last but not least, the final command on this sub-list is to go back to the main OpenFOAM folder:
```
cd ..
```

Optional: Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
```
ln -s /usr/bin/mpicc.openmpi OpenFOAM-5.x/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-5.x/bin/mpirun
```
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.

A few details need to be fixed, before proceeding, which will change the default Boost and CGAL versions:

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

For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:

uname -m

Now, accordingly:

For i686:

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

For x86_64, it depends on whether you need 64-bit integer support or not:

For building with the normal 32-bit integer support (maximum 2.147×10⁹ cells, faces or points):

source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes

For building with the normal 64-bit integer support (maximum 9.22×10¹⁸ cells, faces or points):

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

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:

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'

Save an alias in the personal .bashrc file, simply by running the following command:
```
echo "alias of5x='source \$HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
```
Note: This last line means that whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-5.x shell environment. In other words, whenever you start a new terminal, you should run:
```
of5x
```
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
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:
```
cd $WM_THIRD_PARTY_DIR
./makeCmake > log.makeCM 2>&1
wmRefresh
```

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):

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*

Now let's get and build Gcc 4.8.5 and company:
```
./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
```
If it still gives you the same error message from #3, then something went wrong...

Now let's get and build a custom GNU Binutils:

./getBinutils
./makeBinutils gcc-4.8.5 > log.makeBinutils 2>&1

Now let's build the 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:

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

Now, in order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
1. For building ParaView with Python and MPI, run:
```
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
```
2. Once the makeParaView script is finished running, make sure to check the contents of the file log.makePV and check if there are any errors. If you have any problems building or using ParaView, please check the ParaView installation FAQ page.
3. Finally, update the shell environment:
```
wmRefresh
```
Now let's build OpenFOAM:
1. Go into OpenFOAM's main source folder:
```
cd $WM_PROJECT_DIR
```
2. This next command will take a while... somewhere between 30 minutes to 3-6 hours:
```
./Allwmake -j 4 > log.make 2>&1
```
  Note: The "4" refers to the number of cores to be used for building in parallel. In addition, the amount of RAM needed for building scales with the number of cores used, something like 1GB of RAM per core; a minimum of 1.5GB is needed for linking the libraries, which is not done in parallel.
3. Run it a second time for getting a summary of the installation:
```
./Allwmake -j 4 > log.make 2>&1
```
  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.
To check if everything went well:
1. Check if icoFoam is working, by running this command:
```
icoFoam -help
```
  which should tell you something like this:
```
Usage: icoFoam [OPTIONS]
options:
  -case <dir>       specify alternate case directory, default is the cwd
  -noFunctionObjects
                    do not execute functionObjects
  -parallel         run in parallel
  -roots <(dir1 .. dirN)>
                    slave root directories for distributed running
  -srcDoc           display source code in browser
  -doc              display application documentation in browser
  -help             print the usage
```
  Note: And keep in mind that you need to be careful with the letter case of the command. It's icoFoam, not icoFOAM.
2. If the previous command failed to work properly, then edit the file log.make and check if there are any error messages. A few examples on how you can edit this file:
  - By using kwrite:
```
kwrite log.make
```
  - By using gedit:
```
gedit log.make
```
  - By using nano:
```
nano log.make
```
    You can then exit by using the key combination Ctrl+X and following any instructions it gives you.
  Note: It's the first error message that matters.
3. If you don't understand the output, then please compress the log-file log.make and attach the compressed file to a post in the designated thread.
  If you do not know how to create a compressed file, then try one of the following examples:
  - You can compress the file with gzip by running this command:
```
gzip < log.make > log.make.gz
```
    Then attach the resulting package file named log.make.gz to a post in the designated thread.
  - Or you can compress one or more log-files into a tarball package file, by running this command:
```
tar -czf logs.tar.gz log.*
```
    Then attach the resulting package file named logs.tar.gz to a post in the designated thread.
4. Instructions on how to further diagnose the issue yourself, have a look at the section Common errors when building OpenFOAM from source code in the page FAQ/Installation and Running.
Now you can go read the User Guide, where you may have more than one choice:
1. Which you can find a local copy of the User Guide by running the following command:
```
ls -A1 $WM_PROJECT_DIR/doc/Guides*/*UserGuide*.pdf
```
  - You should see two available formats: A4 and US-Letter.
  - But if it instead tells you that there is No such file or directory, then the OpenFOAM environment is possibly not properly activated.
2. You can also find the more recent OpenFOAM Foundation User Guides online at the following page: official OpenFOAM User Guide - but be careful if you use the version that is too much ahead of the version you are currently using, given that some features have changed overtime.
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.
Note: When you want to update your build, follow the instructions on section Steps for updating on the parent page.

Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-5.x shell environment. In other words, run the following command whenever you start a new terminal:

of5x

For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

2.2 Ubuntu 14.04

Here you have the following choices:

You can install from source, by either:
- Following the official instructions from here: OpenFOAM Source Repository
- Or by following the detailed step-by-step instructions below...

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

Steps:

Switch to root mode (administrator), to install the necessary packages:
```
sudo -s
```
- If the 'sudo' command tells you're not in the sudoers list, then run:
```
su -
```
Update the apt-get cache by running:
```
apt-get update
```

Install the necessary packages:

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

Note: It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:

apt-get install libglu1-mesa-dev libqt4-opengl-dev

Now exit from the root mode:
```
exit
```

Download and unpack (here you can copy-paste all in single go):

#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

But we will now have to download a few more of the necessary packages for the ThirdParty-5.x folder:

First, we need to prepare for the downloads:
```
cd ThirdParty-5.x
mkdir download
```

Now, we need to download the essential source code packages for these instructions you are following (the links are from the file README.org):

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

Next, we need to unpack the packages we've downloaded:

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/'

Last but not least, the final command on this sub-list is to go back to the main OpenFOAM folder:
```
cd ..
```

Optional: Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
```
ln -s /usr/bin/mpicc.openmpi OpenFOAM-5.x/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-5.x/bin/mpirun
```
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.
A few details need to be fixed, before proceeding, which will change the default CGAL version:
```
sed -i -e 's/$cgal_version=$cgal-system/\1CGAL-4.10/' OpenFOAM-5.x/etc/config.sh/CGAL
```
For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
```
uname -m
```
Now, accordingly:
- For i686:
```
source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
```
- For x86_64, it depends on whether you need 64-bit integer support or not:
  - For building with the normal 32-bit integer support (maximum 2.147×10⁹ cells, faces or points):
```
source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc FOAMY_HEX_MESH=yes
```
  - For building with the normal 64-bit integer support (maximum 9.22×10¹⁸ cells, faces or points):
```
source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
```
Save an alias in the personal .bashrc file, simply by running the following command:
```
echo "alias of5x='source \$HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
```
Note: This last line means that whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-5.x shell environment. In other words, whenever you start a new terminal, you should run:
```
of5x
```
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
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:
```
cd $WM_THIRD_PARTY_DIR
./makeCmake > log.makeCM 2>&1
wmRefresh
```

Now let's build the ThirdParty folder, because we need the shell environment to be updated afterwards, for CGAL to be properly picked up for building OpenFOAM:

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

Now, in order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
1. Make sure you're running in the ThirdParty folder and that the correct Qt version is used:
```
cd $WM_THIRD_PARTY_DIR
export QT_SELECT=qt4
```
2. 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:
```
uname -m
```
  Now, accordingly:
  - For i686:
```
#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
```
  - For x86_64:
```
#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
```
3. Once the makeParaView script is finished running, make sure to check the contents of the file log.makePV and check if there are any errors. If you have any problems building or using ParaView, please check the ParaView installation FAQ page.
4. Finally, update the shell environment:
```
wmRefresh
```
Now let's build OpenFOAM:
1. Go into OpenFOAM's main source folder and be certain that the correct Qt version is being used:
```
cd $WM_PROJECT_DIR
export QT_SELECT=qt4
```
2. This next command will take a while... somewhere between 30 minutes to 3-6 hours:
```
./Allwmake -j 4 > log.make 2>&1
```
  Note: The "4" refers to the number of cores to be used for building in parallel. In addition, the amount of RAM needed for building scales with the number of cores used, something like 1GB of RAM per core; a minimum of 1.5GB is needed for linking the libraries, which is not done in parallel.
3. Run it a second time for getting a summary of the installation:
```
./Allwmake -j 4 > log.make 2>&1
```
  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.
To check if everything went well:
1. Check if icoFoam is working, by running this command:
```
icoFoam -help
```
  which should tell you something like this:
```
Usage: icoFoam [OPTIONS]
options:
  -case <dir>       specify alternate case directory, default is the cwd
  -noFunctionObjects
                    do not execute functionObjects
  -parallel         run in parallel
  -roots <(dir1 .. dirN)>
                    slave root directories for distributed running
  -srcDoc           display source code in browser
  -doc              display application documentation in browser
  -help             print the usage
```
  Note: And keep in mind that you need to be careful with the letter case of the command. It's icoFoam, not icoFOAM.
2. If the previous command failed to work properly, then edit the file log.make and check if there are any error messages. A few examples on how you can edit this file:
  - By using kwrite:
```
kwrite log.make
```
  - By using gedit:
```
gedit log.make
```
  - By using nano:
```
nano log.make
```
    You can then exit by using the key combination Ctrl+X and following any instructions it gives you.
  Note: It's the first error message that matters.
3. If you don't understand the output, then please compress the log-file log.make and attach the compressed file to a post in the designated thread.
  If you do not know how to create a compressed file, then try one of the following examples:
  - You can compress the file with gzip by running this command:
```
gzip < log.make > log.make.gz
```
    Then attach the resulting package file named log.make.gz to a post in the designated thread.
  - Or you can compress one or more log-files into a tarball package file, by running this command:
```
tar -czf logs.tar.gz log.*
```
    Then attach the resulting package file named logs.tar.gz to a post in the designated thread.
4. Instructions on how to further diagnose the issue yourself, have a look at the section Common errors when building OpenFOAM from source code in the page FAQ/Installation and Running.
Now you can go read the User Guide, where you may have more than one choice:
1. Which you can find a local copy of the User Guide by running the following command:
```
ls -A1 $WM_PROJECT_DIR/doc/Guides*/*UserGuide*.pdf
```
  - You should see two available formats: A4 and US-Letter.
  - But if it instead tells you that there is No such file or directory, then the OpenFOAM environment is possibly not properly activated.
2. You can also find the more recent OpenFOAM Foundation User Guides online at the following page: official OpenFOAM User Guide - but be careful if you use the version that is too much ahead of the version you are currently using, given that some features have changed overtime.
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.
Note: When you want to update your build, follow the instructions on section Steps for updating on the parent page.

Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-5.x shell environment. In other words, run the following command whenever you start a new terminal:

of5x

For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

2.3 Ubuntu 16.04

Here you have the following choices:

You can install from source, by either:
- Following the official instructions from here: 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: No thread available. Please a create a new thread in the forum.

Steps:

Switch to root mode (administrator), to install the necessary packages:
```
sudo -s
```
- If the 'sudo' command tells you're not in the sudoers list, then run:
```
su -
```
Update the apt-get cache by running:
```
apt-get update
```

Install the necessary packages:

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

Note: It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:

apt-get install libglu1-mesa-dev libqt4-opengl-dev

Now exit from the root mode:
```
exit
```

Download and unpack (here you can copy-paste all in single go):

#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

Optional: Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
```
ln -s /usr/bin/mpicc.openmpi OpenFOAM-5.x/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-5.x/bin/mpirun
```
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.
For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
```
uname -m
```
Now, accordingly:
- For i686:
```
source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
```
- For x86_64, it depends on whether you need 64-bit integer support or not:
  - For building with the normal 32-bit integer support (maximum 2.147×10⁹ cells, faces or points):
```
source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc FOAMY_HEX_MESH=yes
```
  - For building with the normal 64-bit integer support (maximum 9.22×10¹⁸ cells, faces or points):
```
source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
```
Save an alias in the personal .bashrc file, simply by running the following command:
```
echo "alias of5x='source \$HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
```
Note: This last line means that whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-5.x shell environment. In other words, whenever you start a new terminal, you should run:
```
of5x
```
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
In order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
1. Make sure you're running in the ThirdParty folder and that the correct Qt version is used:
```
cd $WM_THIRD_PARTY_DIR
export QT_SELECT=qt4
```
2. 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:
```
uname -m
```
  Now, accordingly:
  - For i686:
```
#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
```
  - For x86_64:
```
#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
```
3. Once the makeParaView script is finished running, make sure to check the contents of the file log.makePV and check if there are any errors. If you have any problems building or using ParaView, please check the ParaView installation FAQ page.
4. Finally, update the shell environment:
```
wmRefresh
```
Now let's build OpenFOAM:
1. Go into OpenFOAM's main source folder and be certain that the correct Qt version is being used:
```
cd $WM_PROJECT_DIR
export QT_SELECT=qt4
```
2. This next command will take a while... somewhere between 30 minutes to 3-6 hours:
```
./Allwmake -j 4 > log.make 2>&1
```
  Note: The "4" refers to the number of cores to be used for building in parallel. In addition, the amount of RAM needed for building scales with the number of cores used, something like 1GB of RAM per core; a minimum of 1.5GB is needed for linking the libraries, which is not done in parallel.
3. Run it a second time for getting a summary of the installation:
```
./Allwmake -j 4 > log.make 2>&1
```
  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.
To check if everything went well:
1. Check if icoFoam is working, by running this command:
```
icoFoam -help
```
  which should tell you something like this:
```
Usage: icoFoam [OPTIONS]
options:
  -case <dir>       specify alternate case directory, default is the cwd
  -noFunctionObjects
                    do not execute functionObjects
  -parallel         run in parallel
  -roots <(dir1 .. dirN)>
                    slave root directories for distributed running
  -srcDoc           display source code in browser
  -doc              display application documentation in browser
  -help             print the usage
```
  Note: And keep in mind that you need to be careful with the letter case of the command. It's icoFoam, not icoFOAM.
2. If the previous command failed to work properly, then edit the file log.make and check if there are any error messages. A few examples on how you can edit this file:
  - By using kwrite:
```
kwrite log.make
```
  - By using gedit:
```
gedit log.make
```
  - By using nano:
```
nano log.make
```
    You can then exit by using the key combination Ctrl+X and following any instructions it gives you.
  Note: It's the first error message that matters.
3. If you don't understand the output, then please compress the log-file log.make and attach the compressed file to a post in the designated thread.
  If you do not know how to create a compressed file, then try one of the following examples:
  - You can compress the file with gzip by running this command:
```
gzip < log.make > log.make.gz
```
    Then attach the resulting package file named log.make.gz to a post in the designated thread.
  - Or you can compress one or more log-files into a tarball package file, by running this command:
```
tar -czf logs.tar.gz log.*
```
    Then attach the resulting package file named logs.tar.gz to a post in the designated thread.
4. Instructions on how to further diagnose the issue yourself, have a look at the section Common errors when building OpenFOAM from source code in the page FAQ/Installation and Running.
Now you can go read the User Guide, where you may have more than one choice:
1. Which you can find a local copy of the User Guide by running the following command:
```
ls -A1 $WM_PROJECT_DIR/doc/Guides*/*UserGuide*.pdf
```
  - You should see two available formats: A4 and US-Letter.
  - But if it instead tells you that there is No such file or directory, then the OpenFOAM environment is possibly not properly activated.
2. You can also find the more recent OpenFOAM Foundation User Guides online at the following page: official OpenFOAM User Guide - but be careful if you use the version that is too much ahead of the version you are currently using, given that some features have changed overtime.
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.
Note: When you want to update your build, follow the instructions on section Steps for updating on the parent page.

Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-5.x shell environment. In other words, run the following command whenever you start a new terminal:

of5x

For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

2.4 Ubuntu 18.04

Here you have the following choices:

You can install from source, by either:
- Following the official instructions from here: OpenFOAM Source Repository
- Or by following the detailed step-by-step instructions below...

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

Steps:

Switch to root mode (administrator), to install the necessary packages:
```
sudo -s
```
- If the 'sudo' command tells you're not in the sudoers list, then run:
```
su -
```
Update the apt-get cache by running:
```
apt-get update
```

Install the necessary packages:

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

Note: It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:

apt-get install libglu1-mesa-dev libqt4-opengl-dev

Now exit from the root mode:
```
exit
```

Download and unpack (here you can copy-paste all in single go):

#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

Optional: Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
```
ln -s /usr/bin/mpicc.openmpi OpenFOAM-5.x/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-5.x/bin/mpirun
```
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.
For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
```
uname -m
```
Now, accordingly:
- For i686:
```
source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
```
- For x86_64, it depends on whether you need 64-bit integer support or not:
  - For building with the normal 32-bit integer support (maximum 2.147×10⁹ cells, faces or points):
```
source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc FOAMY_HEX_MESH=yes
```
  - For building with the normal 64-bit integer support (maximum 9.22×10¹⁸ cells, faces or points):
```
source $HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
```
Save an alias in the personal .bashrc file, simply by running the following command:
```
echo "alias of5x='source \$HOME/OpenFOAM/OpenFOAM-5.x/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
```
Note: This last line means that whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-5.x shell environment. In other words, whenever you start a new terminal, you should run:
```
of5x
```
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
In order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
1. Make sure you're running in the ThirdParty folder and that the correct Qt version is used:
```
cd $WM_THIRD_PARTY_DIR
export QT_SELECT=qt4
```
2. 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:
```
uname -m
```
  Now, accordingly:
  - For i686:
```
#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
```
  - For x86_64:
```
#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
```
3. Once the makeParaView script is finished running, make sure to check the contents of the file log.makePV and check if there are any errors. If you have any problems building or using ParaView, please check the ParaView installation FAQ page.
4. Finally, update the shell environment:
```
wmRefresh
```
Now let's build OpenFOAM:
1. Go into OpenFOAM's main source folder and be certain that the correct Qt version is being used:
```
cd $WM_PROJECT_DIR
export QT_SELECT=qt4
```
2. This next command will take a while... somewhere between 30 minutes to 3-6 hours:
```
./Allwmake -j 4 > log.make 2>&1
```
  Note: The "4" refers to the number of cores to be used for building in parallel. In addition, the amount of RAM needed for building scales with the number of cores used, something like 1GB of RAM per core; a minimum of 1.5GB is needed for linking the libraries, which is not done in parallel.
3. Run it a second time for getting a summary of the installation:
```
./Allwmake -j 4 > log.make 2>&1
```
  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.
To check if everything went well:
1. Check if icoFoam is working, by running this command:
```
icoFoam -help
```
  which should tell you something like this:
```
Usage: icoFoam [OPTIONS]
options:
  -case <dir>       specify alternate case directory, default is the cwd
  -noFunctionObjects
                    do not execute functionObjects
  -parallel         run in parallel
  -roots <(dir1 .. dirN)>
                    slave root directories for distributed running
  -srcDoc           display source code in browser
  -doc              display application documentation in browser
  -help             print the usage
```
  Note: And keep in mind that you need to be careful with the letter case of the command. It's icoFoam, not icoFOAM.
2. If the previous command failed to work properly, then edit the file log.make and check if there are any error messages. A few examples on how you can edit this file:
  - By using kwrite:
```
kwrite log.make
```
  - By using gedit:
```
gedit log.make
```
  - By using nano:
```
nano log.make
```
    You can then exit by using the key combination Ctrl+X and following any instructions it gives you.
  Note: It's the first error message that matters.
3. If you don't understand the output, then please compress the log-file log.make and attach the compressed file to a post in the designated thread.
  If you do not know how to create a compressed file, then try one of the following examples:
  - You can compress the file with gzip by running this command:
```
gzip < log.make > log.make.gz
```
    Then attach the resulting package file named log.make.gz to a post in the designated thread.
  - Or you can compress one or more log-files into a tarball package file, by running this command:
```
tar -czf logs.tar.gz log.*
```
    Then attach the resulting package file named logs.tar.gz to a post in the designated thread.
4. Instructions on how to further diagnose the issue yourself, have a look at the section Common errors when building OpenFOAM from source code in the page FAQ/Installation and Running.
Now you can go read the User Guide, where you may have more than one choice:
1. Which you can find a local copy of the User Guide by running the following command:
```
ls -A1 $WM_PROJECT_DIR/doc/Guides*/*UserGuide*.pdf
```
  - You should see two available formats: A4 and US-Letter.
  - But if it instead tells you that there is No such file or directory, then the OpenFOAM environment is possibly not properly activated.
2. You can also find the more recent OpenFOAM Foundation User Guides online at the following page: official OpenFOAM User Guide - but be careful if you use the version that is too much ahead of the version you are currently using, given that some features have changed overtime.
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.
Note: When you want to update your build, follow the instructions on section Steps for updating on the parent page.

Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-5.x shell environment. In other words, run the following command whenever you start a new terminal:

of5x

For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

Installation/Linux/OpenFOAM-5.x/Ubuntu

1 Introduction

Contents

2 Copy-Paste steps

2.1 Ubuntu 12.04

2.2 Ubuntu 14.04

2.3 Ubuntu 16.04

2.4 Ubuntu 18.04