Difference between revisions of "Installation/Linux/OpenFOAM-2.2.2/CentOS SL RHEL"

From OpenFOAMWiki
m (make*.log -> log.make* - this makes it easier to tell apart from the script names)
(Now using the template for accessing the user guide)
 
Line 156: Line 156:
 
./Allwmake
 
./Allwmake
 
</bash></li>
 
</bash></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>
 
</ol>
 
</ol>
  

Latest revision as of 15:22, 27 October 2018

1 Introduction

This page is dedicated to explaining how to install OpenFOAM OF Version 222.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.4.

Both SL and CentOS derive from RHEL, but CentFOAM is what inspired this page. 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.4

Note: this was tested with the normal DVD of CentOS 6.4, installed in a virtual machine.

Discussion thread where you can ask questions about these steps: Error installing OpenFOAM 2.2.0 on CentOS 6.4

Note: In post #15 you can find a script that can assist in automating most of the steps below.


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 openmpi openmpi-devel qt-devel zlib-devel texinfo
     
    #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
    wget "http://downloads.sourceforge.net/foam/OpenFOAM-2.2.2.tgz?use_mirror=mesh" -O OpenFOAM-2.2.2.tgz
    wget "http://downloads.sourceforge.net/foam/ThirdParty-2.2.2.tgz?use_mirror=mesh" -O ThirdParty-2.2.2.tgz
     
    tar -xzf OpenFOAM-2.2.2.tgz 
    tar -xzf ThirdParty-2.2.2.tgz
  6. 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 i386:
      #forcefully load Open-MPI into the environment
      #the export command has been reported as needed due to the 
      #module not being available in a clean installation
      module load openmpi-i386 || export PATH=$PATH:/usr/lib/openmpi/bin
       
      #here you can change 4 to the number of cores you've got
      source $HOME/OpenFOAM/OpenFOAM-2.2.2/etc/bashrc WM_NCOMPPROCS=4 foamCompiler=ThirdParty \
      WM_COMPILER=Gcc45 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32

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

      echo "alias of222='module load openmpi-i386; source \$HOME/OpenFOAM/OpenFOAM-2.2.2/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 2.2.2 shell environment. In other words, whenever you start a new terminal, you should run:
      of222
      
      For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
    • For x86_64:
      #forcefully load Open-MPI into the environment
      #the export command has been reported as needed due to the 
      #module not being available in a clean installation
      module load openmpi-x86_64 || export PATH=$PATH:/usr/lib64/openmpi/bin 
       
      #here you can change 4 to the number of cores you've got
      source $HOME/OpenFOAM/OpenFOAM-2.2.2/etc/bashrc WM_NCOMPPROCS=4 foamCompiler=ThirdParty \
      WM_COMPILER=Gcc45 WM_MPLIB=SYSTEMOPENMPI

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

      echo "alias of222='module load openmpi-x86_64; source \$HOME/OpenFOAM/OpenFOAM-2.2.2/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 2.2.2 shell environment. In other words, whenever you start a new terminal, you should run:
      of222
      
      For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

    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-2.2.2/etc/config/settings.sh:
        Cannot find /home/user/OpenFOAM/ThirdParty-2.2.2/platforms/linux64/gcc-4.5.2 installation.
        Please install this compiler version or if you wish to use the system compiler,
        change the 'foamCompiler' setting to 'system'
  7. Now we'll have to get all of the scripts we'll need to build GCC and binutils (because OpenFOAM 2.2 requires at least GCC 4.5 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*
     
    #we need to disable the ''multilib'' functionality, since we won't need to build both 32 and 64bit architectures.
    sed -i -e 's=\(--with-system-zlib \)=\1--disable-multilib =' makeGcc
  8. Now let's get and build Gcc 4.5.2 and company:
    ./getGcc gcc-4.5.2
    ./makeGcc gcc-4.5.2 gmp-5.0.1 mpfr-2.4.2 mpc-0.8.1 > log.mkgcc 2>&1
    wmSET $FOAM_SETTINGS

    If it still gives you the same error message from #3, then something went wrong...

  9. Now let's get and build a custom GNU Binutils:
    ./getBinutils
    ./makeBinutils gcc-4.5.2 > log.mkbinutils 2>&1
  10. Now let's build OpenFOAM:
    #Go into OpenFOAM's main source folder
    cd $WM_PROJECT_DIR
     
    # This next command will take a while... somewhere between 30 minutes to 3-6 hours.
    ./Allwmake > log.make 2>&1
     
    #Run it a second time for getting a summary of the installation
    ./Allwmake > log.make 2>&1
  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. CentOS 6.3 comes with CMake 2.6.4, but ParaView 3.12.0 needs a one of the versions from the more recent CMake 2.8.x series. Therefore, we'll need to do a custom build:
    cd $WM_THIRD_PARTY_DIR
    wget "https://raw.github.com/wyldckat/scripts4OpenFOAM3rdParty/master/getCmake"
    chmod +x getCmake
    ./getCmake
    ./makeCmake
    wmSET $FOAM_SETTINGS
  13. Now, in order to build ParaView 3.12.0 that comes with OpenFOAM:
    cd $WM_THIRD_PARTY_DIR
    ./makeParaView -qmake $(which qmake-qt4)
     
    cd $FOAM_UTILITIES/postProcessing/graphics/PV3Readers 
    wmSET $FOAM_SETTINGS
    ./Allwclean 
    ./Allwmake
  14. 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.


Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM 2.2.2 shell environment. In other words, run the following command whenever you start a new terminal:
of222
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: Error installing OpenFOAM 2.2.0 on CentOS 6.4