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

From OpenFOAMWiki
(Ubuntu 14.04: Added link to thread about installing on Ubuntu 14.04)
(Ubuntu 14.04: On Ubuntu 14.04, we must use "QT_SELECT")
Line 341: Line 341:
  
 
<li>Now, in order to build ParaView 4.1.0 that comes with OpenFOAM:
 
<li>Now, in order to build ParaView 4.1.0 that comes with OpenFOAM:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
+
<bash>#First make very certain that the correct Qt version is being used, by running this command:
./makeParaView4 -qmake $(which qmake-qt4) > log.makePV 2>&1
+
export QT_SELECT=qt4
 +
 
 +
#this will take a while... somewhere between 30 minutes to 2 hours or more
 +
./makeParaView4 > log.makePV 2>&1
  
 
#update the shell environment
 
#update the shell environment
Line 353: Line 356:
 
<bash>#Go into OpenFOAM's main source folder
 
<bash>#Go into OpenFOAM's main source folder
 
cd $WM_PROJECT_DIR
 
cd $WM_PROJECT_DIR
 +
 +
#Still better be certain that the correct Qt version is being used
 +
export QT_SELECT=qt4
  
 
# This next command will take a while... somewhere between 30 minutes to 3-6 hours.
 
# This next command will take a while... somewhere between 30 minutes to 3-6 hours.

Revision as of 15:30, 8 June 2014

1 Introduction

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


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 at least two choices:


Discussion thread where you can ask questions about these steps: none so far.

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:
    apt-get install build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev gnuplot libreadline-dev \
    libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev libmpfr-dev
  3. Now exit from the root mode:
    exit
  4. 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.3.0.tgz?use_mirror=mesh" -O OpenFOAM-2.3.0.tgz
    wget "http://downloads.sourceforge.net/foam/ThirdParty-2.3.0.tgz?use_mirror=mesh" -O ThirdParty-2.3.0.tgz
     
    tar -xzf OpenFOAM-2.3.0.tgz 
    tar -xzf ThirdParty-2.3.0.tgz
  5. 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-2.3.0/bin/mpicc
    ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.3.0/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.

  6. 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:
      #here you can change 4 to the number of cores you've got
      source $HOME/OpenFOAM/OpenFOAM-2.3.0/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32
    • For x86_64:
      #here you can change 4 to the number of cores you've got
      source $HOME/OpenFOAM/OpenFOAM-2.3.0/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI
  7. Save an alias in the personal .bashrc file:
    echo "alias of230='source \$HOME/OpenFOAM/OpenFOAM-2.3.0/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.3.0 shell environment. In other words, whenever you start a new terminal, you should run:
    of230
    
    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. 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
     
    # This next command will take a while... somewhere between 5 minutes to 30 minutes.
    ./Allwmake > make.log 2>&1
     
    #update the shell environment
    wmSET $FOAM_SETTINGS
  9. Ubuntu 12.04 comes with CMake 2.8.7, but ParaView 4.1.0 needs CMake 2.8.8 or newer series. Therefore, we'll need to do a custom build:
    cd $WM_THIRD_PARTY_DIR
    wget "https://raw.github.com/wyldckat/scripts4OpenFOAM3rdParty/master/getCmake"
    sed -i -e 's=version}\.3=version}.12.1=' getCmake
    chmod +x getCmake
    ./getCmake
    ./makeCmake
    wmSET $FOAM_SETTINGS
  10. Now, in order to build ParaView 4.1.0 that comes with OpenFOAM:
    #this will take a while... somewhere between 30 minutes to 2 hours or more
    ./makeParaView4 -qmake $(which qmake-qt4) > log.makePV 2>&1
     
    #update the shell environment
    wmSET $FOAM_SETTINGS
    Once the makeParaView4 scripts is finished running, make sure to check the contents of the file log.makePV and check if there are any errors.
  11. Now let's build OpenFOAM:
    (Warning: this may take somewhere from 30 minutes to 6 hours, depending on your machine.)
    #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 > make.log 2>&1
     
    #Run it a second time for getting a summary of the installation
    ./Allwmake > make.log 2>&1
  12. To check if everything went well:
    #Check if icoFoam is working
    icoFoam -help
     
    #Edit the file "make.log" and check if there are any error messages
    #Example:
    gedit make.log
     
    #Create a tarball in case you've seen any errors (it's the first error that matters)
    #or if you don't understand the output
    #and attach the file "make.log.tar.gz" to a post in the designated thread
    tar -czf make.log.tar.gz make.log
  13. Now you can go read the User Guide: official OpenFOAM User Guide


Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM 2.3.0 shell environment. In other words, run the following command whenever you start a new terminal:
of230
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: none so far.


2.2 Ubuntu 13.10

Here you have at least two choices:


Discussion thread where you can ask questions about these steps: none so far.

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:
    apt-get install build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev gnuplot libreadline-dev \
    libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev libmpfr-dev
  3. Now exit from the root mode:
    exit
  4. 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.3.0.tgz?use_mirror=mesh" -O OpenFOAM-2.3.0.tgz
    wget "http://downloads.sourceforge.net/foam/ThirdParty-2.3.0.tgz?use_mirror=mesh" -O ThirdParty-2.3.0.tgz
     
    tar -xzf OpenFOAM-2.3.0.tgz 
    tar -xzf ThirdParty-2.3.0.tgz
  5. 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-2.3.0/bin/mpicc
    ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.3.0/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.

  6. 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:
      #here you can change 4 to the number of cores you've got
      source $HOME/OpenFOAM/OpenFOAM-2.3.0/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32
    • For x86_64:
      #here you can change 4 to the number of cores you've got
      source $HOME/OpenFOAM/OpenFOAM-2.3.0/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI
  7. Save an alias in the personal .bashrc file:
    echo "alias of230='source \$HOME/OpenFOAM/OpenFOAM-2.3.0/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.3.0 shell environment. In other words, whenever you start a new terminal, you should run:
    of230
    
    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. 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
     
    # This next command will take a while... somewhere between 5 minutes to 30 minutes.
    ./Allwmake > make.log 2>&1
     
    #update the shell environment
    wmSET $FOAM_SETTINGS
  9. Now, in order to build ParaView 4.1.0 that comes with OpenFOAM:
    #this will take a while... somewhere between 30 minutes to 2 hours or more
    ./makeParaView4 -qmake $(which qmake-qt4) > log.makePV 2>&1
     
    #update the shell environment
    wmSET $FOAM_SETTINGS
    Once the makeParaView4 scripts is finished running, make sure to check the contents of the file log.makePV and check if there are any errors.
  10. Now let's build OpenFOAM:
    (Warning: this may take somewhere from 30 minutes to 6 hours, depending on your machine.)
    #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 > make.log 2>&1
     
    #Run it a second time for getting a summary of the installation
    ./Allwmake > make.log 2>&1
  11. To check if everything went well:
    #Check if icoFoam is working
    icoFoam -help
     
    #Edit the file "make.log" and check if there are any error messages
    #Example:
    gedit make.log
     
    #Create a tarball in case you've seen any errors (it's the first error that matters)
    #or if you don't understand the output
    #and attach the file "make.log.tar.gz" to a post in the designated thread
    tar -czf make.log.tar.gz make.log
  12. Now you can go read the User Guide: official OpenFOAM User Guide


Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM 2.3.0 shell environment. In other words, run the following command whenever you start a new terminal:
of230
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: none so far.


2.3 Ubuntu 14.04

Here you have the following choices:

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

Discussion thread where you can ask questions about these steps: Paraview not found when installing OpenFoam to Ubuntu 14.04

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:
    apt-get install build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev gnuplot libreadline-dev \
    libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev libmpfr-dev
  3. Now exit from the root mode:
    exit
  4. 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.3.0.tgz?use_mirror=mesh" -O OpenFOAM-2.3.0.tgz
    wget "http://downloads.sourceforge.net/foam/ThirdParty-2.3.0.tgz?use_mirror=mesh" -O ThirdParty-2.3.0.tgz
     
    tar -xzf OpenFOAM-2.3.0.tgz 
    tar -xzf ThirdParty-2.3.0.tgz
  5. 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-2.3.0/bin/mpicc
    ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.3.0/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.

  6. 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:
      #here you can change 4 to the number of cores you've got
      source $HOME/OpenFOAM/OpenFOAM-2.3.0/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32
    • For x86_64:
      #here you can change 4 to the number of cores you've got
      source $HOME/OpenFOAM/OpenFOAM-2.3.0/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI
  7. Save an alias in the personal .bashrc file:
    echo "alias of230='source \$HOME/OpenFOAM/OpenFOAM-2.3.0/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.3.0 shell environment. In other words, whenever you start a new terminal, you should run:
    of230
    
    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. 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
     
    # This next command will take a while... somewhere between 5 minutes to 30 minutes.
    ./Allwmake > make.log 2>&1
     
    #update the shell environment
    wmSET $FOAM_SETTINGS
  9. Now, in order to build ParaView 4.1.0 that comes with OpenFOAM:
    #First make very certain that the correct Qt version is being used, by running this command:
    export QT_SELECT=qt4
     
    #this will take a while... somewhere between 30 minutes to 2 hours or more
    ./makeParaView4 > log.makePV 2>&1
     
    #update the shell environment
    wmSET $FOAM_SETTINGS
    Once the makeParaView4 scripts is finished running, make sure to check the contents of the file log.makePV and check if there are any errors.
  10. Now let's build OpenFOAM:
    (Warning: this may take somewhere from 30 minutes to 6 hours, depending on your machine.)
    #Go into OpenFOAM's main source folder
    cd $WM_PROJECT_DIR
     
    #Still better be certain that the correct Qt version is being used
    export QT_SELECT=qt4
     
    # This next command will take a while... somewhere between 30 minutes to 3-6 hours.
    ./Allwmake > make.log 2>&1
     
    #Run it a second time for getting a summary of the installation
    ./Allwmake > make.log 2>&1
  11. To check if everything went well:
    #Check if icoFoam is working
    icoFoam -help
     
    #Edit the file "make.log" and check if there are any error messages
    #Example:
    gedit make.log
     
    #Create a tarball in case you've seen any errors (it's the first error that matters)
    #or if you don't understand the output
    #and attach the file "make.log.tar.gz" to a post in the designated thread
    tar -czf make.log.tar.gz make.log
  12. Now you can go read the User Guide: official OpenFOAM User Guide


Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM 2.3.0 shell environment. In other words, run the following command whenever you start a new terminal:
of230
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: Paraview not found when installing OpenFoam to Ubuntu 14.04