Installation/swak4Foam/Installing On/Ubuntu

From OpenFOAMWiki
< Installation‎ | swak4Foam‎ | Installing On
Revision as of 18:00, 30 April 2016 by Wyldckat (Talk | contribs)

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

1 Introduction

This page is dedicated to explaining how to install swak4Foam 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 to 13.10

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

Steps:

  1. Install the necessary packages:
    sudo apt-get install build-essential bison flex subversion git mercurial wget

    The following packages are optional, depending on where you download it from:

    • subversion - If you're going to download from an SVN repository.
    • git - If you're going to download from a Git repository.
    • mercurial - If you're going to download from a Mercurial repository.
    • wget - If you're going to download a snapshot directly from the command line.

    You might only know which optional package you'll need, when following the instructions from the following step.

  2. Now, to download and unpack swak4Foam, please follow the respective instructions from this page: Installation/swak4Foam/Downloading - once you've completed the download and unpacking process, then you can proceed to the following step.
  3. Now let's build swak4Foam:
    #Go into swak4Foam's main source folder
    cd swak4Foam
     
    # This next command will take a while...
    ./Allwmake > log.make 2>&1
     
    #Run it a second time for getting a summary of the installation
    ./Allwmake > log.make 2>&1
    Tip
    If using a GCC or ICC compiler (and not clang), then before running Allwmake, the following command can define the number of cores to be used for a faster build process:
    export WM_NCOMPPROCS=4
    Where 4 means that the machine has got 4 processor cores. Using a value larger than the number of cores the machine has got, can risk using more memory than the machine has got and leading to a freeze or crash.
  4. If you're not familiar with OpenFOAM's build process, namely to check if everything built as intended, then check the instructions given at this page: Installation/swak4Foam/Understanding Error Messages
  5. If everything went well, then head onto the main swak4Foam page: Contrib/swak4Foam

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


2.2 Ubuntu 14.04 to 15.10

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

Steps:

  1. Install the necessary packages:
    sudo apt-get install build-essential flex subversion git mercurial wget

    The following packages are optional, depending on where you download it from:

    • subversion - If you're going to download from an SVN repository.
    • git - If you're going to download from a Git repository.
    • mercurial - If you're going to download from a Mercurial repository.
    • wget - If you're going to download a snapshot directly from the command line.

    You might only know which optional package you'll need, when following the instructions from the following step.

  2. Now, to download and unpack swak4Foam, please follow the respective instructions from this page: Installation/swak4Foam/Downloading - once you've completed the download and unpacking process, then you can proceed to the following step.
  3. Now let's build the dependencies that are needed, because the more Ubuntu versions have a bison version that is too new, therefore we need to build an older one:
    #Go into swak4Foam's main source folder
    cd swak4Foam
     
    #build the custom bison
    ./maintainanceScripts/compileRequirements.sh
  4. Now let's build swak4Foam:
    # This next command will take a while...
    ./Allwmake > log.make 2>&1
     
    #Run it a second time for getting a summary of the installation
    ./Allwmake > log.make 2>&1
    Tip
    If using a GCC or ICC compiler (and not clang), then before running Allwmake, the following command can define the number of cores to be used for a faster build process:
    export WM_NCOMPPROCS=4
    Where 4 means that the machine has got 4 processor cores. Using a value larger than the number of cores the machine has got, can risk using more memory than the machine has got and leading to a freeze or crash.
  5. If you're not familiar with OpenFOAM's build process, namely to check if everything built as intended, then check the instructions given at this page: Installation/swak4Foam/Understanding Error Messages
  6. If everything went well, then head onto the main swak4Foam page: Contrib/swak4Foam

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