Difference between revisions of "Installation/Linux/OpenFOAM-dev/Ubuntu"

From OpenFOAMWiki
(Updated CGAL to 4.7)
(Ubuntu 16.04: Added mention to the Ansible instructions)
 
(48 intermediate revisions by 2 users not shown)
Line 16: Line 16:
 
== Ubuntu 12.04 ==
 
== Ubuntu 12.04 ==
  
'''Discussion thread where you can ask questions about these steps''': ''None at the moment.''
+
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:
 
Steps:
 
<ol>
 
<ol>
 
{{Installation/Linux/SwitchToRoot}}
 
{{Installation/Linux/SwitchToRoot}}
 
+
{{Installation/Linux/AptGetUpdate}}
 
<li>Install the necessary packages:
 
<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 \
 
<bash>apt-get install git-core build-essential 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 \
+
libncurses-dev libxt-dev python python-dev
python python-dev
+
 
</bash>
 
</bash>
 
'''Note''': It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:
 
'''Note''': It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:
Line 50: Line 55:
  
 
<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}}):
 
<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  http://www.paraview.org/files/v4.4/ParaView-v4.4.0-source.tar.gz
+
<bash>wget -P download  https://www.cmake.org/files/v3.9/cmake-3.9.0.tar.gz
wget -P download http://www.cmake.org/files/v3.2/cmake-3.2.1.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://gforge.inria.fr/frs/download.php/file/34099/scotch_6.0.3.tar.gz
+
wget -P download https://sourceforge.net/projects/boost/files/boost/1.55.0/boost_1_55_0.tar.bz2
wget -P download https://github.com/CGAL/cgal/releases/download/releases%2FCGAL-4.7/CGAL-4.7.tar.xz
+
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>
 
</bash>
 
</li>
 
</li>
  
 
<li>Next, we need to unpack the packages we've downloaded:
 
<li>Next, we need to unpack the packages we've downloaded:
<bash>tar -xzf download/ParaView-v4.4.0-source.tar.gz
+
<bash>tar -xzf download/cmake-3.9.0.tar.gz
tar -xzf download/cmake-3.2.1.tar.gz
+
tar -xJf download/CGAL-4.10.tar.xz
tar -xzf download/scotch_6.0.3.tar.gz
+
tar -xjf download/boost_1_55_0.tar.bz2
tar -xf download/CGAL-4.7.tar.xz
+
tar -xjf download/openmpi-2.1.1.tar.bz2
</bash>
+
tar -xzf download/ParaView-v5.4.0.tar.gz --transform='s/ParaView-v5.4.0/ParaView-5.4.0/'
</li>
+
 
+
<li>And we need to correct some folder names... in this case, it's just ParaView:
+
<bash>mv ParaView-v4.4.0-source ParaView-4.4.0
+
 
</bash>
 
</bash>
 
</li>
 
</li>
Line 77: Line 79:
 
</li>
 
</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:
+
<li>A few details need to be fixed, before proceeding, which will change the default Boost and CGAL versions:
<bash>ln -s /usr/bin/mpicc.openmpi OpenFOAM-dev/bin/mpicc
+
<bash>sed -i -e 's/\(boost_version=\)boost-system/\1boost_1_55_0/' OpenFOAM-dev/etc/config.sh/CGAL
ln -s /usr/bin/mpirun.openmpi OpenFOAM-dev/bin/mpirun</bash>
+
sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.10/' OpenFOAM-dev/etc/config.sh/CGAL
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.
+
</bash>
 
</li>
 
</li>
  
Line 88: Line 90:
 
<ul {{NoIndentStyle}}>
 
<ul {{NoIndentStyle}}>
 
<li>For i686:
 
<li>For i686:
<bash>source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_ARCH_OPTION=32
+
<bash>source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_MPLIB=OPENMPI WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
 
</bash></li>
 
</bash></li>
  
 
<li>For x86_64, it depends on whether you need 64-bit integer support or not:
 
<li>For x86_64, it depends on whether you need 64-bit integer support or not:
<ul>
+
<ul {{NoIndentStyle}}>
 
<li>For building with the normal 32-bit integer support (maximum 2.147×10<sup>9</sup> cells, faces or points):
 
<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-dev/etc/bashrc
+
<bash>source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes
 
</bash>
 
</bash>
 
</li>
 
</li>
 
<li>For building with the normal 64-bit integer support (maximum 9.22×10<sup>18</sup> cells, faces or points):
 
<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-dev/etc/bashrc WM_LABEL_SIZE=64
+
<bash>source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_MPLIB=OPENMPI WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
 
</bash>
 
</bash>
 
</li>
 
</li>
Line 104: Line 106:
 
</li>
 
</li>
 
</ul>
 
</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-dev/etc/config/settings.sh:
 +
    Cannot find /home/user/OpenFOAM/ThirdParty-dev/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>
  
Line 112: Line 120:
 
</li>
 
</li>
  
<li>Ubuntu 12.04 comes with CMake 2.8.7, but ParaView 4.4.0 needs CMake 3.0 or newer series and CGAL also needs CMake. Therefore, we'll need to do a custom build:
+
<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
 
<bash>cd $WM_THIRD_PARTY_DIR
 
./makeCmake > log.makeCM 2>&1
 
./makeCmake > log.makeCM 2>&1
wmSET $FOAM_SETTINGS
+
wmRefresh
</bash></li>
+
</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:
+
<li>Now we'll have to get all of the scripts we'll need to build GCC and binutils (because OpenFOAM-dev 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
 
<bash>cd $WM_THIRD_PARTY_DIR
  
Line 125: Line 155:
  
 
#update the shell environment
 
#update the shell environment
wmSET $FOAM_SETTINGS
+
wmRefresh
 
</bash>
 
</bash>
 
</li>
 
</li>
  
<li>Now, in order to build ParaView 4.4.0, including with the ability to use Python and MPI, several steps are needed:
+
<li>Now, in order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
 
<ol>
 
<ol>
 
<li>For building ParaView with Python and MPI, run:
 
<li>For building ParaView with Python and MPI, run:
Line 135: Line 165:
  
 
#this will take a while... somewhere between 30 minutes to 2 hours or more
 
#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView4 -python -mpi -python-lib /usr/lib/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
+
./makeParaView -python -mpi -python-lib /usr/lib/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
 
</li>
 
</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>{{Installation/ParaView/BuildProblemsCheckFAQ|makeParaView|log.makePV}}
 
</li>
 
</li>
 
<li>Finally, update the shell environment:
 
<li>Finally, update the shell environment:
<bash>wmSET $FOAM_SETTINGS</bash>
+
<bash>wmRefresh</bash>
 
</li>
 
</li>
 
</ol>
 
</ol>
Line 151: Line 181:
 
</li>
 
</li>
 
<li>This next command will take a while... somewhere between 30 minutes to 3-6 hours:
 
<li>This next command will take a while... somewhere between 30 minutes to 3-6 hours:
<bash>./Allwmake -j 4 > make.log 2>&1</bash>
+
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
'''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.
+
{{Installation/Linux/NumberOfCores}}
 
</li>
 
</li>
 
<li>Run it a second time for getting a summary of the installation:
 
<li>Run it a second time for getting a summary of the installation:
<bash>./Allwmake -j 4 > make.log 2>&1</bash>
+
<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.
 
'''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>
 
</li>
Line 163: Line 193:
 
<li>{{Installation/Linux/CheckIfAllWentWell}}</li>
 
<li>{{Installation/Linux/CheckIfAllWentWell}}</li>
  
<li>Now you can go read the User Guide: [http://www.openfoam.org/docs/user/ official OpenFOAM User Guide]</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>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-dev#Steps for updating|Steps for updating]] on the parent page.</li>
 
</ol>
 
</ol>
  
Line 172: Line 204:
  
  
'''Discussion thread where you can ask questions about these steps''': ''None at the moment.''
+
'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}
  
 
== Ubuntu 14.04 ==
 
== Ubuntu 14.04 ==
  
'''Discussion thread where you can ask questions about these steps''': ''None at the moment.''
+
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:
 
Steps:
 
<ol>
 
<ol>
 
{{Installation/Linux/SwitchToRoot}}
 
{{Installation/Linux/SwitchToRoot}}
 
+
{{Installation/Linux/AptGetUpdate}}
 
<li>Install the necessary packages:
 
<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 \
+
<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 \
 
libreadline-dev libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev \
 
libmpfr-dev python python-dev
 
libmpfr-dev python python-dev
Line 201: Line 239:
 
git clone https://github.com/OpenFOAM/ThirdParty-dev.git
 
git clone https://github.com/OpenFOAM/ThirdParty-dev.git
 
</bash>
 
</bash>
But we will now have to download a few more of the necessary packages for the {{tt|ThirdParty-2.4.x}} folder:
+
But we will now have to download a few more of the necessary packages for the {{tt|ThirdParty-dev}} folder:
 
<ol>
 
<ol>
 
<li>First, we need to prepare for the downloads:
 
<li>First, we need to prepare for the downloads:
Line 210: Line 248:
  
 
<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}}):
 
<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 http://www.paraview.org/files/v4.4/ParaView-v4.4.0-source.tar.gz
+
<bash>wget -P download https://github.com/CGAL/cgal/releases/download/releases/CGAL-4.10/CGAL-4.10.tar.xz
wget -P download https://gforge.inria.fr/frs/download.php/file/34099/scotch_6.0.3.tar.gz
+
wget -P download http://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.7/CGAL-4.7.tar.xz
+
wget -P download http://www.paraview.org/files/v5.4/ParaView-v5.4.0.tar.gz</bash>
</bash>
+
 
</li>
 
</li>
  
 
<li>Next, we need to unpack the packages we've downloaded:
 
<li>Next, we need to unpack the packages we've downloaded:
<bash>tar -xzf download/ParaView-v4.4.0-source.tar.gz
+
<bash>tar -xJf download/CGAL-4.10.tar.xz
tar -xzf download/scotch_6.0.3.tar.gz
+
tar -xzf download/cmake-3.9.0.tar.gz
tar -xf download/CGAL-4.7.tar.xz
+
tar -xzf download/ParaView-v5.4.0.tar.gz --transform='s/ParaView-v5.4.0/ParaView-5.4.0/'</bash>
</bash>
+
</li>
+
 
+
<li>And we need to correct some folder names... in this case, it's just ParaView:
+
<bash>mv ParaView-v4.4.0-source ParaView-4.4.0
+
</bash>
+
 
</li>
 
</li>
  
Line 239: Line 270:
 
ln -s /usr/bin/mpirun.openmpi OpenFOAM-dev/bin/mpirun</bash>
 
ln -s /usr/bin/mpirun.openmpi OpenFOAM-dev/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.
 
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-dev/etc/config.sh/CGAL
 +
</bash>
 
</li>
 
</li>
  
Line 246: Line 282:
 
<ul {{NoIndentStyle}}>
 
<ul {{NoIndentStyle}}>
 
<li>For i686:
 
<li>For i686:
<bash>source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_ARCH_OPTION=32
+
<bash>source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
 
</bash></li>
 
</bash></li>
  
 
<li>For x86_64, it depends on whether you need 64-bit integer support or not:
 
<li>For x86_64, it depends on whether you need 64-bit integer support or not:
<ul>
+
<ul {{NoIndentStyle}}>
 
<li>For building with the normal 32-bit integer support (maximum 2.147×10<sup>9</sup> cells, faces or points):
 
<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-dev/etc/bashrc
+
<bash>source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc FOAMY_HEX_MESH=yes
 
</bash>
 
</bash>
 
</li>
 
</li>
 
<li>For building with the normal 64-bit integer support (maximum 9.22×10<sup>18</sup> cells, faces or points):
 
<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-dev/etc/bashrc WM_LABEL_SIZE=64
+
<bash>source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
 
</bash>
 
</bash>
 
</li>
 
</li>
Line 269: Line 305:
 
{{Installation/Linux/AliasNote|OpenFOAM-dev|ofdev}}
 
{{Installation/Linux/AliasNote|OpenFOAM-dev|ofdev}}
 
</li>
 
</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:
 
<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:
Line 277: Line 319:
  
 
# This next command will take a while... somewhere between 5 minutes to 30 minutes.
 
# This next command will take a while... somewhere between 5 minutes to 30 minutes.
./Allwmake > make.log 2>&1
+
./Allwmake > log.make 2>&1
  
 
#update the shell environment
 
#update the shell environment
wmSET $FOAM_SETTINGS
+
wmRefresh
 
</bash>
 
</bash>
 
</li>
 
</li>
  
<li>Now, in order to build ParaView 4.4.0, including with the ability to use Python and MPI, several steps are needed:
+
<li>Now, in order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
 
<ol>
 
<ol>
 
<li>Make sure you're running in the {{tt|ThirdParty}} folder and that the correct Qt version is used:
 
<li>Make sure you're running in the {{tt|ThirdParty}} folder and that the correct Qt version is used:
Line 297: Line 339:
 
<li>For i686:
 
<li>For i686:
 
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
 
<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>
+
./makeParaView -python -mpi -python-lib /usr/lib/i386-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
 
</li>
 
</li>
  
 
<li>For x86_64:
 
<li>For x86_64:
 
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
 
<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>
+
./makeParaView -python -mpi -python-lib /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
 
</li>
 
</li>
 
</ul>
 
</ul>
 
</li>
 
</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>{{Installation/ParaView/BuildProblemsCheckFAQ|makeParaView|log.makePV}}
 
</li>
 
</li>
 
<li>Finally, update the shell environment:
 
<li>Finally, update the shell environment:
<bash>wmSET $FOAM_SETTINGS</bash>
+
<bash>wmRefresh</bash>
 
</li>
 
</li>
 
</ol>
 
</ol>
Line 322: Line 364:
  
 
<li>This next command will take a while... somewhere between 30 minutes to 3-6 hours:
 
<li>This next command will take a while... somewhere between 30 minutes to 3-6 hours:
<bash>./Allwmake -j 4 > make.log 2>&1</bash>
+
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
'''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.
+
{{Installation/Linux/NumberOfCores}}
 
</li>
 
</li>
 
<li>Run it a second time for getting a summary of the installation:
 
<li>Run it a second time for getting a summary of the installation:
<bash>./Allwmake -j 4 > make.log 2>&1</bash>
+
<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.
 
'''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>
 
</li>
Line 334: Line 376:
 
<li>{{Installation/Linux/CheckIfAllWentWell}}</li>
 
<li>{{Installation/Linux/CheckIfAllWentWell}}</li>
  
<li>Now you can go read the User Guide: [http://www.openfoam.org/docs/user/ official OpenFOAM User Guide]</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>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-dev#Steps for updating|Steps for updating]] on the parent page.</li>
 
</ol>
 
</ol>
  
  
{{Installation/Linux/AliasReminder|OpenFOAM 2.4.x|of24x}}
+
{{Installation/Linux/AliasReminder|OpenFOAM-dev|ofdev}}
  
  
'''Discussion thread where you can ask questions about these steps''': ''None at the moment.''
+
'''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
 +
</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-dev.git
 +
git clone https://github.com/OpenFOAM/ThirdParty-dev.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-dev/bin/mpicc
 +
ln -s /usr/bin/mpirun.openmpi OpenFOAM-dev/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-dev/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-dev/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-dev/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 ofdev='source \$HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
 +
</bash>
 +
{{Installation/Linux/AliasNote|OpenFOAM-dev|ofdev}}
 +
</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-dev#Steps for updating|Steps for updating]] on the parent page.</li>
 +
</ol>
 +
 
 +
 
 +
{{Installation/Linux/AliasReminder|OpenFOAM-dev|ofdev}}
 +
 
 +
 
 +
'''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-dev.git
 +
git clone https://github.com/OpenFOAM/ThirdParty-dev.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-dev/bin/mpicc
 +
ln -s /usr/bin/mpirun.openmpi OpenFOAM-dev/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-dev/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-dev/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-dev/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 ofdev='source \$HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
 +
</bash>
 +
{{Installation/Linux/AliasNote|OpenFOAM-dev|ofdev}}
 +
</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-dev#Steps for updating|Steps for updating]] on the parent page.</li>
 +
</ol>
 +
 
 +
 
 +
{{Installation/Linux/AliasReminder|OpenFOAM-dev|ofdev}}
  
  
== Ubuntu 15.04 ==
+
'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}
The instructions written for [[#Ubuntu 14.04|Ubuntu 14.04]] also work in 15.04.
+
  
== Ubuntu 15.10 ==
 
The instructions written for [[#Ubuntu 14.04|Ubuntu 14.04]] also work in 15.10.
 
  
  
 
[[Category:Installing OpenFOAM on Linux]] [[Category:Installing OpenFOAM on Ubuntu]]
 
[[Category:Installing OpenFOAM on Linux]] [[Category:Installing OpenFOAM on Ubuntu]]

Latest revision as of 15:53, 27 October 2018

1 Introduction

This page is dedicated to explaining how to install OpenFOAM OF Version FoundationDev.png 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. And please do keep in mind that these instructions can easily go out of date, because the OpenFOAM development repository is the bleeding edge. For more details about this version, see the parent page Installation/Linux/OpenFOAM-dev.


2 Copy-Paste steps

A few notes before you start copy-pasting:

  1. Lines that start with # don't have to be copy-pasted. They are just comments to let you know what's going on.
  2. 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:

  1. 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 -
  2. Update the apt-get cache by running:
    apt-get update
  3. 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
  4. Now exit from the root mode:
    exit
  5. 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-dev.git
    git clone https://github.com/OpenFOAM/ThirdParty-dev.git

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

    1. First, we need to prepare for the downloads:
      cd ThirdParty-dev
      mkdir download
    2. 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
    3. 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/'
    4. Last but not least, the final command on this sub-list is to go back to the main OpenFOAM folder:
      cd ..
  6. 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-dev/etc/config.sh/CGAL
    sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.10/' OpenFOAM-dev/etc/config.sh/CGAL
  7. 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-dev/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×109 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-dev/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×1018 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-dev/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-dev/etc/config/settings.sh:
        Cannot find /home/user/OpenFOAM/ThirdParty-dev/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'
  8. Save an alias in the personal .bashrc file, simply by running the following command:
    echo "alias ofdev='source \$HOME/OpenFOAM/OpenFOAM-dev/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-dev shell environment. In other words, whenever you start a new terminal, you should run:
    ofdev
    
    For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
  9. 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
  10. Now we'll have to get all of the scripts we'll need to build GCC and binutils (because OpenFOAM-dev 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*
  11. 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...

  12. Now let's get and build a custom GNU Binutils:
    ./getBinutils
    ./makeBinutils gcc-4.8.5 > log.makeBinutils 2>&1
  13. 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
  14. 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
  15. 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.

  16. 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.
  17. 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.
  18. 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.
  19. 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-dev shell environment. In other words, run the following command whenever you start a new terminal:
ofdev
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:

  1. 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 -
  2. Update the apt-get cache by running:
    apt-get update
  3. 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
  4. Now exit from the root mode:
    exit
  5. 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-dev.git
    git clone https://github.com/OpenFOAM/ThirdParty-dev.git

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

    1. First, we need to prepare for the downloads:
      cd ThirdParty-dev
      mkdir download
    2. 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
    3. 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/'
    4. Last but not least, the final command on this sub-list is to go back to the main OpenFOAM folder:
      cd ..
  6. 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-dev/bin/mpicc
    ln -s /usr/bin/mpirun.openmpi OpenFOAM-dev/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.

  7. 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-dev/etc/config.sh/CGAL
  8. 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-dev/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×109 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc FOAMY_HEX_MESH=yes
      • For building with the normal 64-bit integer support (maximum 9.22×1018 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
  9. Save an alias in the personal .bashrc file, simply by running the following command:
    echo "alias ofdev='source \$HOME/OpenFOAM/OpenFOAM-dev/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-dev shell environment. In other words, whenever you start a new terminal, you should run:
    ofdev
    
    For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
  10. 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
  11. 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
  12. 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
  13. 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.

  14. 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.
  15. 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.
  16. 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.
  17. 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-dev shell environment. In other words, run the following command whenever you start a new terminal:
ofdev
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:


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

Steps:

  1. 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 -
  2. Update the apt-get cache by running:
    apt-get update
  3. 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

    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
  4. Now exit from the root mode:
    exit
  5. 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-dev.git
    git clone https://github.com/OpenFOAM/ThirdParty-dev.git
  6. 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-dev/bin/mpicc
    ln -s /usr/bin/mpirun.openmpi OpenFOAM-dev/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.

  7. 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-dev/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×109 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc FOAMY_HEX_MESH=yes
      • For building with the normal 64-bit integer support (maximum 9.22×1018 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
  8. Save an alias in the personal .bashrc file, simply by running the following command:
    echo "alias ofdev='source \$HOME/OpenFOAM/OpenFOAM-dev/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-dev shell environment. In other words, whenever you start a new terminal, you should run:
    ofdev
    
    For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
  9. 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
  10. 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.

  11. 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.
  12. 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.
  13. 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.
  14. 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-dev shell environment. In other words, run the following command whenever you start a new terminal:
ofdev
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:

  1. 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 -
  2. Update the apt-get cache by running:
    apt-get update
  3. 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
  4. Now exit from the root mode:
    exit
  5. 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-dev.git
    git clone https://github.com/OpenFOAM/ThirdParty-dev.git
  6. 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-dev/bin/mpicc
    ln -s /usr/bin/mpirun.openmpi OpenFOAM-dev/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.

  7. 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-dev/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×109 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc FOAMY_HEX_MESH=yes
      • For building with the normal 64-bit integer support (maximum 9.22×1018 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
  8. Save an alias in the personal .bashrc file, simply by running the following command:
    echo "alias ofdev='source \$HOME/OpenFOAM/OpenFOAM-dev/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-dev shell environment. In other words, whenever you start a new terminal, you should run:
    ofdev
    
    For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
  9. 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
  10. 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.

  11. 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.
  12. 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.
  13. 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.
  14. 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-dev shell environment. In other words, run the following command whenever you start a new terminal:
ofdev
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.