Installation/Linux/OpenFOAM-6/CentOS SL RHEL

From OpenFOAMWiki
< Installation‎ | Linux‎ | OpenFOAM-6
Revision as of 16:22, 27 October 2018 by Wyldckat (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

1 Introduction

This page is dedicated to explaining how to install OpenFOAM OF Version 6.png in:

  • Community ENTerprise Operating System, aka CentOS.
  • Red Hat Enterprise Linux, aka RHEL.
  • Scientific Linux, aka SL.

In theory, all of the above follow the same versioning. Therefore, at the time this page was first written, RHEL, CentOS and SL were all at version 6.10.

Both SL and CentOS derive from RHEL, but CentFOAM is what inspired this (and other related instruction pages). Therefore, before even trying to follow the instructions on this page, try first CentFOAM.

Last but not least, RHEL uses Fedora as their bleeding edge Linux Distribution, where they test new features. This leads to very close similarities between them, e.g. RHEL 6.3 is very similar to Fedora 14; which means that whatever you can build on Fedora 14, you should also be able to build on RHEL 6.3!

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

  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 CentOS 6.10 (SCL)

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


Notes regarding the instructions below:

  • These instructions rely heavily on the Software Collections ( SCL ) Repository, which can be used to install software in a non-intrusive way... which will require its own environment loading mechanism.
    • This way it's not necessary to compile Python and GCC from source code and instead use pre-built packages provided by the SCL community.
    • If you want to build the majority of the toolboxes from source code (for example, if you do not have root/admin permissions), or build ParaView with Qt 4, then jump to the section CentOS 6.10 (without SCL).
  • The instructions below were tested with CentOS 6.10, but might work with older or newer versions.


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. Install the necessary packages:
    yum groupinstall 'Development Tools' 
    yum install zlib-devel texinfo gstreamer-plugins-base-devel \
    libXext-devel libGLU-devel libXt-devel libXrender-devel libXinerama-devel libpng-devel \
    libXrandr-devel libXi-devel libXft-devel libjpeg-turbo-devel libXcursor-devel \
    readline-devel ncurses-devel mpfr-devel gmp-devel
     
    #This one is useful, but not crucial
    yum upgrade

    Also install the aforementioned SCL repository and the packages we need from it:

    yum install centos-release-SCL
    yum install python27 devtoolset-7
  3. To check if the desired SCL packages are installed, run:
    scl --list
  4. For future reference, the easiest way to activate the environment for the installed SCL packages on the current command line is to run, but do not do this right now:
    source /opt/rh/python27/enable
    source /opt/rh/devtoolset-7/enable

    This command will be indicated to be executed at the right point in the instructions below.

  5. Now exit from the root mode:
    exit
  6. Start a new terminal. This is because you'll need a fully refreshed shell.
  7. 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-6.git
    git clone https://github.com/OpenFOAM/ThirdParty-6.git

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

    1. First, we need to prepare for the downloads:
      cd ThirdParty-6
      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
      wget -P download http://download.qt.io/archive/qt/5.9/5.9.6/single/qt-everywhere-opensource-src-5.9.6.tar.xz
    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/'
      tar -xJf download/qt-everywhere-opensource-src-5.9.6.tar.xz --transform='s/qt-everywhere-opensource-src/qt-everywhere-src/'
    4. Last but not least, the final command on this sub-list is to go back to the main OpenFOAM folder:
      cd ..
  8. 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-6/etc/config.sh/CGAL
    sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.10/' OpenFOAM-6/etc/config.sh/CGAL
  9. Now is the time to load in the SCL packages that were installed, by running:
    source /opt/rh/python27/enable
    source /opt/rh/devtoolset-7/enable
  10. For building OpenFOAM itself, it depends on whether you have installed the i386 or x86_64 architecture of CentOS/SL/RHEL. To check this, run:
    uname -m

    Now, accordingly:

    • For i686:
      source $HOME/OpenFOAM/OpenFOAM-6/etc/bashrc WM_ARCH_OPTION=32 WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes
    • For x86_64, it depends on whether you need 64-bit integer support or not. Depending on whether you need 64-bit integer support or not:
      • For building with the normal 32-bit integer support (maximum 2.147×109 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-6/etc/bashrc 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-6/etc/bashrc WM_LABEL_SIZE=64 WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes
  11. Then save an alias in the personal .bashrc file, simply by running the following command:
    echo "alias of6='source /opt/rh/python27/enable && source /opt/rh/devtoolset-7/enable && source \$HOME/OpenFOAM/OpenFOAM-6/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 6 shell environment. In other words, whenever you start a new terminal, you should run:
    of6
    
    For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
  12. CentOS 6.x comes with CMake 2.6.4, but ParaView 5.4.0 needs a one of the versions from the more recent CMake 3.x series and CGAL also needs CMake. Therefore, we'll need to do a custom build and we have to do it before we build the custom GCC+binutils (reason: [1]):
    cd $WM_THIRD_PARTY_DIR
    ./makeCmake > log.makeCmake 2>&1
    wmRefresh
  13. Now let's build CGAL, because we need to use custom options and we need the shell environment to be updated afterwards, for CGAL to be properly picked up for building OpenFOAM:
    # This next command will take a little while...
    ./makeCGAL > log.makeCGAL 2>&1
     
    #update the shell environment
    wmRefresh
  14. CentOS 6.x comes with Qt 4.6.2, but ParaView 5.4.0 needs at least 4.7. However, since we are using GCC 7, it's best to use a more recent Qt version, namely 5.9.6 was downloaded and unpacked already. Therefore, we'll need to do a custom build of Qt 5.9.6:
    cd $WM_THIRD_PARTY_DIR
     
    #Get the scripts we need
    wget https://github.com/wyldckat/scripts4OpenFOAM3rdParty/raw/master/makeQt5
    wget -P etc/tools/ https://github.com/OpenFOAM/ThirdParty-2.4.x/raw/master/etc/tools/QtFunctions
     
    #make them executable
    chmod +x makeQt5
     
    ./makeQt5 qt-5.9.6 > log.makeQt 2>&1

    Important Note: Building Qt 5 will use up a lot of disk space (roughly 10GB, including the source code package). Therefore, after you've check the contents of the file log.makeQt (or check the last few lines of this file), then you can delete the temporary+intermediate files used to build Qt 5, by running the following commands:

    cd $WM_THIRD_PARTY_DIR
    rm -r build
    rm -r qt-everywhere-src-5.9.6
  15. Given that a custom Open-MPI version is being built with these instructions, it's necessary to first build it before ParaView so that Open-MPI can be used by ParaView:
    cd $WM_THIRD_PARTY_DIR
    ./Allwmake > log.make 2>&1
    wmRefresh
  16. For building ParaView 5.4.0 with Python and MPI, it depends on whether you have installed the i686 or x86_64 architecture of CentOS 6.:
    1. To check this, run:
      uname -m

      Now, accordingly:

      • For i686:
        cd $WM_THIRD_PARTY_DIR
         
        # Load the Python 2.7 that came with the SCL repository
        source /opt/rh/python27/enable
         
        # Need Qt5 to be found by CMake
        export CMAKE_PREFIX_PATH=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER/qt-5.9.6/
         
        #this will take a while... somewhere between 30 minutes to 2 hours or more
        ./makeParaView -qt-5.9.6 -mpi -python -python-lib /opt/rh/python27/root/usr/lib/libpython2.7.so -python-include /opt/rh/python27/root/usr/include/python2.7 > log.makePV 2>&1
      • For x86_64:
        cd $WM_THIRD_PARTY_DIR
         
        # Load the Python 2.7 that came with the SCL repository
        source /opt/rh/python27/enable
         
        # Need Qt5 to be found by CMake
        export CMAKE_PREFIX_PATH=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER/qt-5.9.6/
         
        #this will take a while... somewhere between 30 minutes to 2 hours or more
        ./makeParaView -qt-5.9.6 -mpi -python -python-lib /opt/rh/python27/root/usr/lib64/libpython2.7.so -python-include /opt/rh/python27/root/usr/include/python2.7 > log.makePV 2>&1

      Note: Building with Qt 5 means that OpenGL2 must be used, therefore if you really want to use OpenGL rendering, follow the instructions from section CentOS 6.10 (without SCL) instead.

    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
    4. WARNING: If you have already built ParaView 5.4.0 with Qt 4 on this same machine in which you are now installing OpenFOAM 6, then you should remove the old configuration file for ParaView 5.4.0, otherwise the 3D rendering widget will have the wrong window dimensions. To remove said configuration file, run the following command:
      rm ~/.config/ParaView/ParaView5.4.0.ini
  17. Now let's build OpenFOAM:
    1. Go into OpenFOAM's main source folder:
      cd $WM_PROJECT_DIR
    2. We need to temporarily populate CMAKE_PREFIX_PATH with the path to the custom Qt build, so that qmake is properly found when building OpenFOAM's plug-in libraries for ParaView:
      export CMAKE_PREFIX_PATH=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER/qt-5.9.6/
    3. 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.

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

  18. 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.
  19. 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.
  20. 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 6 shell environment. In other words, run the following command whenever you start a new terminal:
of6
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 CentOS 6.10 (without SCL)

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


Notes regarding the instructions below:

  • These instructions will build GCC 4.8 and Python 2.7 from source code, along with using Qt 4.8.
  • The instructions below were tested with CentOS 6.10, but might work with older or newer versions.


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. Install the necessary packages:
    yum groupinstall 'Development Tools' 
    yum install zlib-devel texinfo gstreamer-plugins-base-devel \
    libXext-devel libGLU-devel libXt-devel libXrender-devel libXinerama-devel libpng-devel \
    libXrandr-devel libXi-devel libXft-devel libjpeg-turbo-devel libXcursor-devel \
    readline-devel ncurses-devel mpfr-devel gmp-devel bzip2-devel openssl-devel \
    sqlite-devel tk-devel gdbm-devel db4-devel libpcap-devel xz-devel expat-devel
     
    #This one is useful, but not crucial
    yum upgrade
  3. Now exit from the root mode:
    exit
  4. Start a new terminal. This is because you'll need a fully refreshed shell.
  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-6.git
    git clone https://github.com/OpenFOAM/ThirdParty-6.git

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

    1. First, we need to prepare for the downloads:
      cd ThirdParty-6
      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
      wget -P download http://download.qt.io/archive/qt/4.8/4.8.7/qt-everywhere-opensource-src-4.8.7.tar.gz
      wget -P download http://python.org/ftp/python/2.7.15/Python-2.7.15.tar.xz
    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/'
      tar -xzf download/qt-everywhere-opensource-src-4.8.7.tar.gz
      tar -xJf download/Python-2.7.15.tar.xz
    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-6/etc/config.sh/CGAL
    sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.10/' OpenFOAM-6/etc/config.sh/CGAL
  7. For building OpenFOAM itself, it depends on whether you have installed the i386 or x86_64 architecture of CentOS/SL/RHEL. To check this, run:
    uname -m

    Now, accordingly:

    • For i686:
      source $HOME/OpenFOAM/OpenFOAM-6/etc/bashrc WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_ARCH_OPTION=32 WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes
    • For x86_64, it depends on whether you need 64-bit integer support or not. Depending on whether you need 64-bit integer support or not:
      • For building with the normal 32-bit integer support (maximum 2.147×109 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-6/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-6/etc/bashrc WM_COMPILER_TYPE=ThirdParty WM_COMPILER=Gcc48 WM_LABEL_SIZE=64 WM_MPLIB=OPENMPI 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-6/etc/config/settings.sh:
        Cannot find /home/user/OpenFOAM/ThirdParty-6/platforms/linux64/gcc-4.8.5 installation.
        Please install this compiler version or if you wish to use the system compiler,
        change the 'WM_COMPILER_TYPE' setting to 'system'
  8. Then save an alias in the personal .bashrc file, simply by running the following command:
    echo "alias of6='source \$HOME/OpenFOAM/OpenFOAM-6/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 6 shell environment. In other words, whenever you start a new terminal, you should run:
    of6
    
    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. Now we'll have to get all of the scripts we'll need to build GCC and binutils (because OpenFOAM-6 requires at least GCC 4.8 and CentOS only provides GCC 4.4):
    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*
  10. CentOS 6.x comes with CMake 2.6.4, but ParaView 5.4.0 needs a one of the versions from the more recent CMake 3.x series and CGAL also needs CMake. Therefore, we'll need to do a custom build and we have to do it before we build the custom GCC+binutils (reason: [2]):
    cd $WM_THIRD_PARTY_DIR
    ./makeCmake > log.makeCmake 2>&1
    wmRefresh
  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 CGAL, because we need to use custom options and we need the shell environment to be updated afterwards, for CGAL to be properly picked up for building OpenFOAM:
    # This next command will take a little while...
    ./makeCGAL > log.makeCGAL 2>&1
     
    #update the shell environment
    wmRefresh
  14. CentOS 6.x comes with Qt 4.6.2, but ParaView 5.4.0 needs at least 4.7. Therefore, we'll need to do a custom build of Qt 4.8.7:
    cd $WM_THIRD_PARTY_DIR
     
    #Get the scripts we need
    wget https://github.com/OpenFOAM/ThirdParty-2.4.x/raw/master/makeQt
    wget -P etc/tools/ https://github.com/OpenFOAM/ThirdParty-2.4.x/raw/master/etc/tools/QtFunctions
     
    #make them executable
    chmod +x makeQt
     
    ./makeQt qt-4.8.7 > log.makeQt 2>&1

    Important Note: Building Qt 4 and GCC will use up a lot of disk space (roughly 5GB, including the source code packages). Therefore, after you've check the contents of the file log.makeQt (or check the last few lines of this file), then you can delete the temporary+intermediate files used to build Qt 4 and GCC, by running the following commands:

    cd $WM_THIRD_PARTY_DIR
    rm -r build
    rm -r qt-everywhere-opensource-src-4.8.7
    rm -r gcc-4.8.5
  15. Given that a custom Open-MPI version is being built with these instructions, it's necessary to first build it before ParaView so that Open-MPI can be used by ParaView:
    cd $WM_THIRD_PARTY_DIR
    ./Allwmake > log.make 2>&1
    wmRefresh
  16. Then to build Python 2.7.15, run the following commands: (WARNING: do not run these as root, or you risk not being able to use yum if OpenFOAM's shell environment)
    cd $WM_THIRD_PARTY_DIR
     
    mkdir -p build/$WM_ARCH$WM_COMPILER/Python-2.7.15
    cd build/$WM_ARCH$WM_COMPILER/Python-2.7.15
     
    export PYTHONHOME=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER/python-2.7.15
    mkdir -p $PYTHONHOME/lib
     
    $WM_THIRD_PARTY_DIR/Python-2.7.15/configure --prefix=$PYTHONHOME --enable-unicode=ucs4 --enable-shared LDFLAGS="-Wl,-rpath $PYTHONHOME/lib"
     
    # Note: Update the 4 to the number of cores you want to use
    (make -j 4 && make altinstall) > $WM_THIRD_PARTY_DIR/log.makePython 2>&1
     
    cd $WM_THIRD_PARTY_DIR

    When it's done, check the contents of the file log.makePython. If all is OK, then run the following commands to finish up the installation:

    cd $WM_THIRD_PARTY_DIR
     
    echo "export PYTHONHOME=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER/python-2.7.15" >> $WM_PROJECT_DIR/etc/prefs.sh
    echo 'export PATH=$PYTHONHOME/bin:$PATH' >> $WM_PROJECT_DIR/etc/prefs.sh
     
    wmRefresh
     
    chmod u+w $PYTHONHOME/lib/libpython2.7.so.1.0
    strip $PYTHONHOME/lib/libpython2.7.so.1.0
    chmod -w $PYTHONHOME/lib/libpython2.7.so.1.0
     
    ln -s python2.7 $PYTHONHOME/bin/python2
    ln -s python2.7 $PYTHONHOME/bin/python
     
    wget https://bootstrap.pypa.io/get-pip.py
    python2.7 get-pip.py
    pip2.7 install virtualenv
    pip2.7 install numpy
  17. For building ParaView 5.4.0 with Python and MPI, it depends on whether you have installed the i686 or x86_64 architecture of CentOS 6.:
    1. To check this, run:
      uname -m

      Now, accordingly:

      • For i686:
        cd $WM_THIRD_PARTY_DIR
         
        #this will take a while... somewhere between 30 minutes to 2 hours or more
        ./makeParaView -qt-4.8.7 -mpi -python -python-lib $PYTHONHOME/lib/libpython2.7.so -python-include $PYTHONHOME/include/python2.7 > log.makePV 2>&1
      • For x86_64:
        cd $WM_THIRD_PARTY_DIR
         
        #this will take a while... somewhere between 30 minutes to 2 hours or more
        ./makeParaView -qt-4.8.7 -mpi -python -python-lib $PYTHONHOME/lib/libpython2.7.so -python-include $PYTHONHOME/include/python2.7 > log.makePV 2>&1

      Note: If you want to use OpenGL instead of OpenGL2, add the option -rendering OpenGL right after makeParaView, e.g.:

      ./makeParaView -rendering OpenGL ...
    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
    4. WARNING: If you have already built ParaView 5.4.0 with Qt 5 on this same machine in which you are now installing OpenFOAM 6, then you should remove the old configuration file for ParaView 5.4.0, otherwise the 3D rendering widget will have the wrong window dimensions. To remove said configuration file, run the following command:
      rm ~/.config/ParaView/ParaView5.4.0.ini
  18. Now let's build OpenFOAM:
    1. Go into OpenFOAM's main source folder:
      cd $WM_PROJECT_DIR
    2. We need to temporarily populate CMAKE_PREFIX_PATH with the path to the custom Qt build, so that qmake is properly found when building OpenFOAM's plug-in libraries for ParaView:
      export CMAKE_PREFIX_PATH=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER/qt-4.8.7/
    3. 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.

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

  19. 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.
  20. 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.
  21. 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 6 shell environment. In other words, run the following command whenever you start a new terminal:
of6
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 CentOS 7.5 (1804)

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


Notes regarding the instructions below:

  • The instructions below were tested with CentOS 7.5, but might work with older 7.0-7.3 or with newer 7.x versions.
  • There is no support for the 32-bit architectures in CentOS 7, therefore these instructions only address the x86_64 architecture.


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. Install the necessary packages:
    yum groupinstall 'Development Tools' 
    yum install zlib-devel libXext-devel libGLU-devel libXt-devel libXrender-devel libXinerama-devel \
    libpng-devel libXrandr-devel libXi-devel libXft-devel libjpeg-turbo-devel libXcursor-devel \
    readline-devel ncurses-devel python python-devel cmake qt-devel qt-assistant \
    mpfr-devel gmp-devel
     
    #This one is useful, but not crucial
    yum upgrade
  3. Now exit from the root mode:
    exit
  4. Start a new terminal. This is because you'll need a fully refreshed shell.
  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-6.git
    git clone https://github.com/OpenFOAM/ThirdParty-6.git

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

    1. First, we need to prepare for the downloads:
      cd ThirdParty-6
      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-6/etc/config.sh/CGAL
    sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.10/' OpenFOAM-6/etc/config.sh/CGAL
  7. For building OpenFOAM itself, first we need to activate the correct environment settings and it depends on whether you need 64-bit integer support or not. Depending on whether you need 64-bit integer support or not:
    • For building with the normal 32-bit integer support (maximum 2.147×109 cells, faces or points):
      source $HOME/OpenFOAM/OpenFOAM-6/etc/bashrc 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-6/etc/bashrc WM_LABEL_SIZE=64 WM_MPLIB=OPENMPI FOAMY_HEX_MESH=yes

    Also, save an alias in the personal .bashrc file, simply by running the following command:

    echo "alias of6='source \$HOME/OpenFOAM/OpenFOAM-6/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 6 shell environment. In other words, whenever you start a new terminal, you should run:
    of6
    
    For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
  8. CentOS 7.4 comes with CMake 2.8.12.1, but ParaView 5.4.0 needs a one of the versions from the more recent CMake 3.x series and CGAL also needs CMake. Therefore, we'll need to do a custom build by running:
    cd $WM_THIRD_PARTY_DIR
    ./makeCmake > log.makeCmake 2>&1
    wmRefresh
  9. Given that a custom Open-MPI version is being built with these instructions, it's necessary to first build it before ParaView so that Open-MPI can be used by ParaView:
    cd $WM_THIRD_PARTY_DIR
    ./Allwmake > log.make 2>&1
    wmRefresh
  10. For building ParaView 5.4.0 with Python and MPI, do the following steps:
    1. Build by running these commands:
      cd $WM_THIRD_PARTY_DIR
       
      #this will take a while... somewhere between 30 minutes to 2 hours or more
      ./makeParaView -mpi -python -qmake $(which qmake-qt4) > log.makePV 2>&1
    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
  11. 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.

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

  13. 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.
  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 6 shell environment. In other words, run the following command whenever you start a new terminal:
of6
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.