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

From OpenFOAMWiki
m (Fedora 27: fixed typo in the package name)
(Fedora 27: revised the step for building ParaView)
Line 219: Line 219:
 
  </bash>
 
  </bash>
 
</li>
 
</li>
<li>For building ParaView with Python and MPI, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
+
<li>For building ParaView with Python and MPI, which will take a while... somewhere between 30 minutes to 2 hours or more, run the following command:
<bash>uname -m</bash>
+
<bash>./makeParaView -python -mpi -qmake $(which qmake-qt5) > log.makePV 2>&1</bash>
Now, accordingly:
+
<ul {{NoIndentStyle}}>
+
<li>For i686:
+
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
+
./makeParaView -python -mpi > log.makePV 2>&1</bash>
+
</li>
+
 
+
<li>For x86_64:
+
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
+
./makeParaView -python -mpi > log.makePV 2>&1</bash>
+
</li>
+
</ul>
+
 
</li>
 
</li>
 
<li>{{Installation/ParaView/BuildProblemsCheckFAQ|makeParaView|log.makePV}}
 
<li>{{Installation/ParaView/BuildProblemsCheckFAQ|makeParaView|log.makePV}}

Revision as of 00:32, 6 January 2018

1 Introduction

This page is dedicated to explaining how to install OpenFOAM OF Version FoundationDev.png in Fedora.

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 Fedora 25/26

Here you have the following choices:

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


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

Steps:

  1. Switch to root mode (administrator), to install the necessary packages:
    sudo -s
    • If the 'sudo' command tells you're not in the sudoers list, then run:
      su -
  2. Update dnf cache:
    dnf update
  3. Install the necessary packages:
    dnf groupinstall 'Development Tools' 'C Development Tools and Libraries'
    dnf install cmake openmpi openmpi-devel python python-devel git gitk binutils-devel mercurial \
     freeglut freeglut-devel libXt-devel libXt qt5-devel qt-devel qtwebkit-devel \
    zlib zlib-devel wget patch readline-devel ncurses ncurses-devel ncurses-libs \
    boost-devel boost-math boost-devel boost-thread boost-system gmp-devel mpfr-devel \
    gmp-devel mpfr-devel CGAL CGAL-devel scotch scotch-devel ptscotch-openmpi \
    ptscotch-openmpi-devel ptscotch-openmpi-devel-parmetis
  4. Now exit from the root mode:
    exit
  5. Download and unpack (here you can copy-paste all in single go):
    #OpenFOAM downloading and installation
    cd ~
    mkdir OpenFOAM
    cd OpenFOAM
    git clone git://github.com/OpenFOAM/OpenFOAM-dev.git
    git clone git://github.com/OpenFOAM/ThirdParty-dev.git
  6. The openMPI library should be added to the PATH manullay using the personal .bashrc file by running:
    echo "export PATH=/usr/lib64/openmpi/bin/:\$PATH" >> $HOME/.bashrc
    echo "export LD_LIBRARY_PATH=/usr/lib64/openmpi/lib/:\$LD_LIBRARY_PATH" >> $HOME/.bashrc
  7. For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
    uname -m

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

    • For i686:
      echo "alias ofdev='source \$HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes'" >> $HOME/.bashrc
    • For x86_64, it depends on whether you need 64-bit integer support or not:
      • For building with the normal 32-bit integer support (maximum 2.147×109 cells, faces or points):
        echo "alias ofdev='source \$HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc FOAMY_HEX_MESH=yes'" >> $HOME/.bashrc
      • For building with the normal 64-bit integer support (maximum 9.22×1018 cells, faces or points):
        echo "alias ofdev='source \$HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes'" >> $HOME/.bashrc
  8. The .bashrc file needs to be sourced to apply the changes:
    source $HOME/.bashrc
    Note: This last line means that whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-dev shell environment. In other words, whenever you start a new terminal, you should run:
    ofdev
    
    For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
  9. In order to build ParaView 5.0.1, including with the ability to use Python and MPI, several steps are needed:
    1. Make sure you're running in the ThirdParty folder and that the correct Qt version is used:
      cd $WM_THIRD_PARTY_DIR
    2. For building ParaView with Python and MPI use the following line which could take while, even more that 2 hours, depending on the specification of the machine:
      ./makeParaView -python -mpi -qmake /usr/lib64/qt5/ > log.makePV 2>&1
    3. Once the makeParaView script is finished running, make sure to check the contents of the file log.makePV and check if there are any errors. If you have any problems building or using ParaView, please check the ParaView installation FAQ page.
    4. Finally, update the shell environment:
      wmRefresh
  10. Now let's build OpenFOAM:
    1. Go into OpenFOAM's main source folder:
      cd $WM_PROJECT_DIR
    2. This next command will take a while... somewhere between 30 minutes to 3-6 hours:
      ./Allwmake -j4 > 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 -j4 > log.make 2>&1

      Note: Technically, the build will stop as soon as the first error is found. Running a second time only makes it easier to sort through between what's already been built and where the crash occurred.

  11. To check if everything went well:
    1. Check if icoFoam is working, by running this command:
      icoFoam -help

      which should tell you something like this:

      Usage: icoFoam [OPTIONS]
      options:
        -case <dir>       specify alternate case directory, default is the cwd
        -noFunctionObjects
                          do not execute functionObjects
        -parallel         run in parallel
        -roots <(dir1 .. dirN)>
                          slave root directories for distributed running
        -srcDoc           display source code in browser
        -doc              display application documentation in browser
        -help             print the usage

      Note: And keep in mind that you need to be careful with the letter case of the command. It's icoFoam, not icoFOAM.

    2. If the previous command failed to work properly, then edit the file log.make and check if there are any error messages. A few examples on how you can edit this file:
      • By using kwrite:
        kwrite log.make
      • By using gedit:
        gedit log.make
      • By using nano:
        nano log.make

        You can then exit by using the key combination Ctrl+X and following any instructions it gives you.

      Note: It's the first error message that matters.

    3. If you don't understand the output, then please compress the log-file log.make and attach the compressed file to a post in the designated thread.
      If you do not know how to create a compressed file, then try one of the following examples:
      • You can compress the file with gzip by running this command:
        gzip < log.make > log.make.gz

        Then attach the resulting package file named log.make.gz to a post in the designated thread.

      • Or you can compress one or more log-files into a tarball package file, by running this command:
        tar -czf logs.tar.gz log.*

        Then attach the resulting package file named logs.tar.gz to a post in the designated thread.

    4. Instructions on how to further diagnose the issue yourself, have a look at the section Common errors when building OpenFOAM from source code in the page FAQ/Installation and Running.
  12. Now you can go read the User Guide: official OpenFOAM User Guide
  13. When you need to update your local clone, for getting the latest source code updates, you can follow the instructions provided in the page Installation/Working with git repositories.
  14. Note: When you want to update your build, follow the instructions on section Steps for updating on the parent page.


Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-dev shell environment. In other words, run the following command whenever you start a new terminal:
ofdev
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.


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


2.2 Fedora 27

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

WARNING: These instructions are currently being written and under testing!

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:
    dnf groupinstall 'Development Tools'  'C Development Tools and Libraries'
    dnf install openmpi openmpi-devel qt5-devel zlib-devel wget CGAL-devel \
    boost-devel gmp-devel mpfr-devel patch readline-devel ncurses-devel python python-devel
  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
    git clone https://github.com/OpenFOAM/OpenFOAM-dev.git
    git clone https://github.com/OpenFOAM/ThirdParty-dev.git
  5. 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 i386:
      #forcefully load Open-MPI into the environment
      module load mpi/openmpi-i386 || export PATH=$PATH:/usr/lib/openmpi/bin
       
      source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_ARCH_OPTION=32

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

      echo "alias ofdev='module load mpi/openmpi-i386; source \$HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
      Note: This last line means that whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-dev shell environment. In other words, whenever you start a new terminal, you should run:
      ofdev
      
      For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
    • For x86_64, first it's necessary to forcefully load Open-MPI into the environment:
      module load mpi/openmpi-x86_64 || export PATH=$PATH:/usr/lib64/openmpi/bin

      Then 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-dev/etc/bashrc FOAMY_HEX_MESH=yes
      • For building with the normal 64-bit integer support (maximum 9.22×1018 cells, faces or points):
        source $HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes

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

      echo "alias ofdev='module load mpi/openmpi-x86_64; source \$HOME/OpenFOAM/OpenFOAM-dev/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
      Note: This last line means that whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-dev shell environment. In other words, whenever you start a new terminal, you should run:
      ofdev
      
      For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
  6. In order to build ParaView 5.4.0, including with the ability to use Python and MPI, several steps are needed:
    1. Make sure you're running in the ThirdParty folder:
      cd $WM_THIRD_PARTY_DIR
    2. For building ParaView with Python and MPI, which will take a while... somewhere between 30 minutes to 2 hours or more, run the following command:
      ./makeParaView -python -mpi -qmake $(which qmake-qt5) > log.makePV 2>&1
    3. Once the makeParaView script is finished running, make sure to check the contents of the file log.makePV and check if there are any errors. If you have any problems building or using ParaView, please check the ParaView installation FAQ page.
    4. Finally, update the shell environment:
      wmRefresh
  7. 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.

  8. 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.
  9. Now you can go read the User Guide: official OpenFOAM User Guide
  10. When you need to update your local clone, for getting the latest source code updates, you can follow the instructions provided in the page Installation/Working with git repositories.
  11. Note: When you want to update your build, follow the instructions on section Steps for updating on the parent page.


Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM-dev shell environment. In other words, run the following command whenever you start a new terminal:
ofdev
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.