Revision as of 19:27, 29 December 2013

1 Introduction

This page is dedicated to explaining how to install the foam-extend project 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 10.04

Here you have at least one choice:

• You can install from source, by:
  • Following the official instructions from one of these repositories:
    • Building Instructions for Ubuntu 10.04 at the official Extend repository
    • Building Instructions for Ubuntu 10.04 at repo.or.cz mirror
    • Building Instructions for Ubuntu 10.04 at Unofficial-Extend-Project-Mirror@github mirror
    • Note: Before following any of the instructions above, check the section Note regarding foam-extend-3.0

2.2 Ubuntu 12.04

Here you have a few choices:

• You can install from source, by either:
  • Following the available official instructions at the auxiliary project page: Download & Install at wikki.gridcore.se
  • Following the available official instructions from one of these repositories:
    • Building Instructions for Ubuntu 12.04 at the official Extend repository
    • Building Instructions for Ubuntu 12.04 at repo.or.cz mirror
    • Building Instructions for Ubuntu 12.04 at Unofficial-Extend-Project-Mirror@github mirror
    • Note: Before following any of the instructions above, check the section Note regarding foam-extend-3.0
  • Or by following the detailed step-by-step instructions below (which has been based on the instructions from previous link)...

WARNING: These instructions are still being written and tested out.

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

Steps:

1. Switch to root mode (administrator) and install the necessary packages (run one line at a time):

   sudo -s
    
   #if the 'sudo' command tells you're not in the sudoers list,
   #then remove the # from the next line:
   #su -
    
   #these 3 lines count as a single line, due to the blackslash "\" character
   apt-get install git flex bison rpm build-essential zlib1g-dev binutils-dev \
   openmpi-bin libopenmpi-dev mercurial qt4-dev-tools libqt4-dev gnuplot \
   libreadline-dev libncurses-dev libxt-dev
    
   exit

2. Set-up the base folder where foam-extend-3.0 will be installed (here you can copy-paste all in single go):

   cd ~
   mkdir foam
   cd foam

3. The next command will depend on the repository mirror you want to use:
   • Extend's official repository:

     git clone git://git.code.sf.net/p/openfoam-extend/OpenFOAM-1.6-ext foam-extend-3.0

   • Extend's official repository (https mode, if you're behind a firewall):

     git clone https://git.code.sf.net/p/openfoam-extend/OpenFOAM-1.6-ext foam-extend-3.0

   • Mirror at repo.or.cz repository:

     git clone git://repo.or.cz/openfoam-extend-OpenFOAM-1.6-ext.git OpenFOAM-1.6-ext.git foam-extend-3.0

   • Mirror at repo.or.cz repository (http mode, if you're behind a firewall):

     git clone http://repo.or.cz/r/openfoam-extend-OpenFOAM-1.6-ext.git foam-extend-3.0

   • Mirror Unofficial-Extend-Project-Mirror@github repository:

     git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-OpenFOAM-1.6-ext.git foam-extend-3.0

4. After the cloning is complete, go into the cloned folder and switch to the master branch:

   cd foam-extend-3.0
   git checkout master

5. Configure the preferences file:

   cp etc/prefs.sh-EXAMPLE etc/prefs.sh
    
   #Use the system compiler and configure to use Gcc 4.6
   echo "export WM_COMPILER=Gcc46" >> etc/prefs.sh
    
   # Use the system installation of OpenMPI
   sed -i s/"#export WM_MPLIB=SYSTEMOPENMPI"/"export WM_MPLIB=SYSTEMOPENMPI"/g etc/prefs.sh
   sed -i s/"#export OPENMPI_DIR=path_to_system_installed_openmpi"/"export OPENMPI_DIR=\/usr"/g etc/prefs.sh
   sed -i s/"^#export OPENMPI_BIN_DIR"/"export OPENMPI_BIN_DIR"/g etc/prefs.sh
    
   # Use the system installation of Qt
   sed -i s/"#export QT_DIR=path_to_system_installed_qt"/"export QT_DIR=\/usr"/g etc/prefs.sh
   sed -i s/"#export QT_BIN_DIR=\$QT_DIR\/bin"/"export QT_BIN_DIR=\$QT_DIR\/bin"/g etc/prefs.sh
    
   #here you can change 4 to the number of cores you've got
   echo "export WM_NCOMPPROCS=4" >> etc/prefs.sh

6. Now to do several more necessary fixes:

   #Create a symbolic link for gmake
   ln -s /usr/bin/make bin/gmake
    
   #disable X dependencies in tecio
   sed -i -e 's=\(U_WIN32\)$=\1 -DENGINE=g' \
    applications/utilities/postProcessing/dataConversion/foamToTecplot360/tecio/tecsrc/Make/tecioOptions

7. For building 1.6-ext 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:

     echo "export WM_ARCH_OPTION=32" >> etc/prefs.sh

   • For x86_64... there's nothing special to do.
8. Activate the environment and save it in the personal .bashrc file:

   source etc/bashrc
    
   echo "source $HOME/foam/foam-extend-3.0/etc/bashrc" >> $HOME/.bashrc

9. Build the several stages of the ThirdParty folder in a single go:

   cd ThirdParty
    
   # This next command will take a while... somewhere between 5 to 30 minutes
   ./AllMake.pre > log.AllMake 2>&1
    
   #Run it a second time for getting a summary of the installation
   ./AllMake.pre > log.AllMake 2>&1

10. To check if everything went well:

    #Edit the file "log.AllMake" and check if there are any error messages
    #Example:
    gedit log.AllMake
     
    #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 "log.AllMake.tar.gz" to a post in the designated thread
    tar -czf log.AllMake.tar.gz log.AllMake

11. Now let's build foam-extend-3.0:

    #Go back to the main folder and update the environment
    cd ..
    source etc/bashrc
     
    # 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 build swak4Foam and PyFoam:

    ThirdParty/AllMake.stage5 > log.AllMake.stage5 2>&1
    ThirdParty/AllMake.stage5 > log.AllMake.stage5 2>&1
     
    ThirdParty/AllMake.stage6 > log.AllMake.stage6 2>&1
    ThirdParty/AllMake.stage6 > log.AllMake.stage6 2>&1

14. Now you can go read the User Guide, which is located at $HOME/foam/foam-extend-3.0/doc/Guides-a4/UserGuide.pdf.

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

2.3 Ubuntu 12.10

Here you have a few choices:

• You can install from source, by either:
  • Following the available official instructions at the auxiliary project page: Download & Install at wikki.gridcore.se
  • Adapting the available official instructions that are for Ubuntu 12.04 (keeping in mind you're trying to install on Ubuntu 12.10), from one of these repositories:
    • Building Instructions for Ubuntu 12.04 at the official Extend repository
    • Building Instructions for Ubuntu 12.04 at repo.or.cz mirror
    • Building Instructions for Ubuntu 12.04 at Unofficial-Extend-Project-Mirror@github mirror
    • Note: Before following any of the instructions above, check the section Note regarding foam-extend-3.0
  • Or by following the detailed step-by-step instructions below (which has been based on the instructions from previous link)...

WARNING: These instructions are still being written and tested out.

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

Steps:

1. Switch to root mode (administrator) and install the necessary packages (run one line at a time):

   sudo -s
    
   #if the 'sudo' command tells you're not in the sudoers list,
   #then remove the # from the next line:
   #su -
    
   #these 2 lines count as a single line, due to the blackslash "\" character
   apt-get install git flex bison rpm build-essential zlib1g-dev binutils-dev \
   openmpi-bin libopenmpi-dev mercurial qt4-dev-tools libqt4-dev gnuplot \
   libreadline-dev libncurses-dev libxt-dev
    
   #just in case, make sure to uninstall the "gold" binutils version
   apt-get remove binutils-gold
    
   exit

2. Set-up the base folder where foam-extend-3.0 will be installed (here you can copy-paste all in single go):

   cd ~
   mkdir foam
   cd foam

3. The next command will depend on the repository mirror you want to use:
   • Extend's official repository:

     git clone git://git.code.sf.net/p/openfoam-extend/OpenFOAM-1.6-ext foam-extend-3.0

   • Extend's official repository (https mode, if you're behind a firewall):

     git clone https://git.code.sf.net/p/openfoam-extend/OpenFOAM-1.6-ext foam-extend-3.0

   • Mirror at repo.or.cz repository:

     git clone git://repo.or.cz/openfoam-extend-OpenFOAM-1.6-ext.git foam-extend-3.0

   • Mirror at repo.or.cz repository (http mode, if you're behind a firewall):

     git clone http://repo.or.cz/r/openfoam-extend-OpenFOAM-1.6-ext.git foam-extend-3.0

   • Mirror Unofficial-Extend-Project-Mirror@github repository:

     git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-OpenFOAM-1.6-ext.git foam-extend-3.0

4. After the cloning is complete, go into the cloned folder and switch to the master branch:

   cd foam-extend-3.0
   git checkout master

5. Configure the preferences file:

   cp etc/prefs.sh-EXAMPLE etc/prefs.sh
    
   #Use the system compiler and configure to use Gcc 4.7
   echo "export WM_COMPILER=Gcc47" >> etc/prefs.sh
    
   # Use the system installation of OpenMPI
   sed -i s/"#export WM_MPLIB=SYSTEMOPENMPI"/"export WM_MPLIB=SYSTEMOPENMPI"/g etc/prefs.sh
   sed -i s/"#export OPENMPI_DIR=path_to_system_installed_openmpi"/"export OPENMPI_DIR=\/usr"/g etc/prefs.sh
   sed -i s/"^#export OPENMPI_BIN_DIR"/"export OPENMPI_BIN_DIR"/g etc/prefs.sh
    
   # Use the system installation of Qt
   sed -i s/"#export QT_DIR=path_to_system_installed_qt"/"export QT_DIR=\/usr"/g etc/prefs.sh
   sed -i s/"#export QT_BIN_DIR=\$QT_DIR\/bin"/"export QT_BIN_DIR=\$QT_DIR\/bin"/g etc/prefs.sh
    
   #here you can change 4 to the number of cores you've got
   echo "export WM_NCOMPPROCS=4" >> etc/prefs.sh

6. Now to do several more necessary fixes:

   #Create a symbolic link for gmake
   ln -s /usr/bin/make bin/gmake
    
   #disable X dependencies in tecio
   sed -i -e 's=\(U_WIN32\)$=\1 -DENGINE=g' \
    applications/utilities/postProcessing/dataConversion/foamToTecplot360/tecio/tecsrc/Make/tecioOptions

7. For building 1.6-ext 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:

     echo "export WM_ARCH_OPTION=32" >> etc/prefs.sh
      
     #copy the rules from ''Gcc46'' to ''Gcc47''
     cp -r wmake/rules/linuxGcc46 wmake/rules/linuxGcc47
      
     # due to stricter name lookup rules in 4.7 we need to tell the compiler to lighten up on this
     sed -i 's/^\(c++FLAGS.*\)/\1 -fpermissive/g' wmake/rules/linuxGcc47/c++

     Note: fix for the c++ file was retrieved from here.
   • For x86_64:

     #copy the rules from ''Gcc46'' to ''Gcc47''
     cp -r wmake/rules/linux64Gcc46 wmake/rules/linux64Gcc47
      
     # due to stricter name lookup rules in 4.7 we need to tell the compiler to lighten up on this
     sed -i 's/^\(c++FLAGS.*\)/\1 -fpermissive/g' wmake/rules/linux64Gcc47/c++

     Note: fix for the c++ file was retrieved from here.
8. Activate the environment and save it in the personal .bashrc file:

   source etc/bashrc
    
   echo "source $HOME/foam/foam-extend-3.0/etc/bashrc" >> $HOME/.bashrc

9. Build the several stages of the ThirdParty folder in a single go:

   cd ThirdParty
    
   # This next command will take a while... somewhere between 5 to 30 minutes
   ./AllMake.pre > log.AllMake 2>&1
    
   #Run it a second time for getting a summary of the installation
   ./AllMake.pre > log.AllMake 2>&1

10. To check if everything went well:

    #Edit the file "log.AllMake" and check if there are any error messages
    #Example:
    gedit log.AllMake
     
    #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 "log.AllMake.tar.gz" to a post in the designated thread
    tar -czf log.AllMake.tar.gz log.AllMake

11. Now let's build foam-extend-3.0:

    #Go back to the main folder and update the environment
    cd ..
    source etc/bashrc
     
    # 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 build swak4Foam and PyFoam:

    ThirdParty/AllMake.stage5 > log.AllMake.stage5 2>&1
    ThirdParty/AllMake.stage5 > log.AllMake.stage5 2>&1
     
    ThirdParty/AllMake.stage6 > log.AllMake.stage6 2>&1
    ThirdParty/AllMake.stage6 > log.AllMake.stage6 2>&1

14. Now you can go read the User Guide, which is located at $HOME/foam/foam-extend-3.0/doc/Guides-a4/UserGuide.pdf.

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

2.4 Ubuntu 13.10

Here you have a few choices:

• You can install from source, by either:
  • Following the available official instructions at the auxiliary project page: Download & Install at wikki.gridcore.se
  • Adapting the available official instructions that are for Ubuntu 12.04 (keeping in mind you're trying to install on Ubuntu 13.10), from one of these repositories:
    • Building Instructions for Ubuntu 12.04 at the official Extend repository
    • Building Instructions for Ubuntu 12.04 at repo.or.cz mirror
    • Building Instructions for Ubuntu 12.04 at Unofficial-Extend-Project-Mirror@github mirror
    • Note: Before following any of the instructions above, check the section Note regarding foam-extend-3.0
  • Or by following the detailed step-by-step instructions below (which has been based on the instructions from previous link)...

WARNING: These instructions are still being written and tested out.

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

Steps:

1. Switch to root mode (administrator) and install the necessary packages (run one line at a time):

   sudo -s
    
   #if the 'sudo' command tells you're not in the sudoers list,
   #then remove the # from the next line:
   #su -
    
   #these 2 lines count as a single line, due to the blackslash "\" character
   apt-get install git flex bison rpm build-essential zlib1g-dev binutils-dev \
   openmpi-bin libopenmpi-dev mercurial qt4-dev-tools libqt4-dev gnuplot \
   libreadline-dev libncurses-dev libxt-dev
    
   #just in case, make sure to uninstall the "gold" binutils version
   apt-get remove binutils-gold
    
   exit

2. Set-up the base folder where foam-extend-3.0 will be installed (here you can copy-paste all in single go):

   cd ~
   mkdir foam
   cd foam

3. The next command will depend on the repository mirror you want to use:
   • Extend's official repository:

     git clone git://git.code.sf.net/p/openfoam-extend/OpenFOAM-1.6-ext foam-extend-3.0

   • Extend's official repository (https mode, if you're behind a firewall):

     git clone https://git.code.sf.net/p/openfoam-extend/OpenFOAM-1.6-ext foam-extend-3.0

   • Mirror at repo.or.cz repository:

     git clone git://repo.or.cz/openfoam-extend-OpenFOAM-1.6-ext.git foam-extend-3.0

   • Mirror at repo.or.cz repository (http mode, if you're behind a firewall):

     git clone http://repo.or.cz/r/openfoam-extend-OpenFOAM-1.6-ext.git foam-extend-3.0

   • Mirror Unofficial-Extend-Project-Mirror@github repository:

     git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-OpenFOAM-1.6-ext.git foam-extend-3.0

4. After the cloning is complete, go into the cloned folder and switch to the master branch:

   cd foam-extend-3.0
   git checkout master

5. Configure the preferences file:

   cp etc/prefs.sh-EXAMPLE etc/prefs.sh
    
   #Use the system compiler and configure to use Gcc 4.8
   sed -i s/"compilerInstall=System"/"compilerInstall=System"/g etc/prefs.sh
   echo "export WM_COMPILER=Gcc48" >> etc/prefs.sh
    
   # Use the system installation of OpenMPI
   sed -i s/"#export WM_MPLIB=SYSTEMOPENMPI"/"export WM_MPLIB=SYSTEMOPENMPI"/g etc/prefs.sh
   sed -i s/"#export OPENMPI_DIR=path_to_system_installed_openmpi"/"export OPENMPI_DIR=\/usr"/g etc/prefs.sh
   sed -i s/"^#export OPENMPI_BIN_DIR"/"export OPENMPI_BIN_DIR"/g etc/prefs.sh
    
   # Use the system installation of Qt
   sed -i s/"#export QT_DIR=path_to_system_installed_qt"/"export QT_DIR=\/usr"/g etc/prefs.sh
   sed -i s/"#export QT_BIN_DIR=\$QT_DIR\/bin"/"export QT_BIN_DIR=\$QT_DIR\/bin"/g etc/prefs.sh
    
   #here you can change 4 to the number of cores you've got
   echo "export WM_NCOMPPROCS=4" >> etc/prefs.sh

6. Now to do several more necessary fixes:

   #Create a symbolic link for gmake
   ln -s /usr/bin/make bin/gmake
    
   #disable X dependencies in tecio
   sed -i -e 's=\(U_WIN32\)$=\1 -DENGINE=g' \
    applications/utilities/postProcessing/dataConversion/foamToTecplot360/tecio/tecsrc/Make/tecioOptions

7. For building 1.6-ext 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:

     echo "export WM_ARCH_OPTION=32" >> etc/prefs.sh
      
     #copy the rules from ''Gcc46'' to ''Gcc48''
     cp -r wmake/rules/linuxGcc46 wmake/rules/linuxGcc48
      
     # due to stricter name lookup rules in 4.8 we need to tell the compiler to lighten up on this
     sed -i 's/^\(c++FLAGS.*\)/\1 -fpermissive/g' wmake/rules/linuxGcc48/c++

     Note: fix for the c++ file was retrieved from here.
   • For x86_64:

     #copy the rules from ''Gcc46'' to ''Gcc48''
     cp -r wmake/rules/linux64Gcc46 wmake/rules/linux64Gcc48
      
     # due to stricter name lookup rules in 4.8 we need to tell the compiler to lighten up on this
     sed -i 's/^\(c++FLAGS.*\)/\1 -fpermissive/g' wmake/rules/linux64Gcc48/c++

     Note: fix for the c++ file was retrieved from here.
8. Activate the environment and save it in the personal .bashrc file:

   source etc/bashrc
    
   echo "source $HOME/foam/foam-extend-3.0/etc/bashrc" >> $HOME/.bashrc

9. Build the several stages of the ThirdParty folder in a single go:

   cd ThirdParty
    
   # This next command will take a while... somewhere between 5 to 30 minutes
   ./AllMake.pre > log.AllMake 2>&1
    
   #Run it a second time for getting a summary of the installation
   ./AllMake.pre > log.AllMake 2>&1

10. To check if everything went well:

    #Edit the file "log.AllMake" and check if there are any error messages
    #Example:
    gedit log.AllMake
     
    #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 "log.AllMake.tar.gz" to a post in the designated thread
    tar -czf log.AllMake.tar.gz log.AllMake

11. Now let's build foam-extend-3.0:

    #Go back to the main folder and update the environment
    cd ..
    source etc/bashrc
     
    # 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 build swak4Foam and PyFoam:

    ThirdParty/AllMake.stage5 > log.AllMake.stage5 2>&1
    ThirdParty/AllMake.stage5 > log.AllMake.stage5 2>&1
     
    ThirdParty/AllMake.stage6 > log.AllMake.stage6 2>&1
    ThirdParty/AllMake.stage6 > log.AllMake.stage6 2>&1

14. Now you can go read the User Guide, which is located at $HOME/foam/foam-extend-3.0/doc/Guides-a4/UserGuide.pdf.

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