Skip to content

[enGrid 1.4] Installation

wyldckat edited this page Mar 11, 2016 · 1 revision

Table of Contents

Recommended Method for Linux Distributions

The recommended installation method is to use the automatic build script which can be found on the git repository for the latest updates to the script: build.bash from git

This script offers easy configuration for the following systems:

  1. Fedora
    1. Fedora 14
    2. Fedora 15
    3. Fedora 16
    4. Fedora 17
  2. openSUSE
    1. openSUSE 11.2
    2. openSUSE 11.3
    3. openSUSE 11.4
    4. openSUSE 12.1
    5. openSUSE 12.2
  3. Ubuntu
    1. Ubuntu 10.10
    2. Ubuntu 11.04
    3. Ubuntu 11.10
    4. Ubuntu 12.04
    5. Ubuntu 12.10
Put the script into the folder where you want to install enGrid. When you execute the script, it will create a sub-folder named engrid where all sources, binaries, and scripts will be installed. For example: If your web browser automatically puts the script into the folder /home/jonny/Download, and you want enGrid to be in the folder /home/jonny/Software/, put the script into the folder /home/jonny/Software you need to issue the following commands to kick off the installation (provided that the folder /home/jonny/Software does not exist yet:
cd /home/jonny
mkdir Software
cd Software
mv /home/jonny/Download/build.bash .
source build.bash
Afterwards the script will print a list of available configurations. Assuming you are installing enGrid onto an Ubuntu system, please type the following:
source build.bash ubuntu
The script will then ask you for the root password, because it needs to launch the system's package manager in order to install the required dependencies. The steps performed by this script are:
  1. install dependencies
    1. VTK >= 5.4
    2. Qt >= 4.5
    3. standard build environment (gcc, make, ...)
  2. fetch enGrid sources from GIT
  3. compile Netgen library
  4. compile enGrid library
  5. compile enGrid executable
Afterwards an optional set-up script can be called in order to create a start script in /usr/bin and a desktop file to be able to start enGrid from the graphical menu system.
engrid/setup_generic.bash
IMPORTANT: Do not source this script -- otherwise it will not work correctly!

Please note that this script is the same for all Linux distributions. The dedicated scripts (e.g. setup_opensuse.bash) are intended for binary packages.

Other Compatible Linux Distributions

The build.bash scripts can also be used for the following Linux Distributions:

  1. Debian 6 - Simply use the ubuntu option:
    source build.bash ubuntu
  2. CentOS 6 - You can use the fedora option, but you first must install the EPEL repository:
    1. Check the newest version of 'epel-release' for EL6.
    2. Use the package name given and use it the next command line for replacing PACKAGENAME:
      sudo rpm -ivh http://download.fedoraproject.org/pub/epel/6/i386/PACKAGENAME
      • Example for epel-release-6-7.noarch.rpm:
        sudo rpm -ivh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-7.noarch.rpm
    3. Update the package manager:
      sudo yum -y update
    4. Run the installation script as usual for Fedora:
      source build.bash fedora

Ubuntu via CAE Team's PPA

In order to make things a bit simpler, enGrid is now available via CAE Team's PPA at Launchpad. To install enGrid, you can simply run (one command at a time):

sudo add-apt-repository ppa:cae-team/ppa
sudo apt-get update
sudo apt-get install engrid
Supported Ubuntu versions:
  • 11.10 Oneiric Ocelot
  • 12.04 Precise Pangolin
  • 12.10 Quantal Quetzal
You can also install the tutorials:
sudo apt-get install engrid-doc
The tutorials will then be available in the folder /usr/share/doc/engrid-doc/tutorials.

And you can also install the scripts for Blender (caution: it will also install Blender):

sudo apt-get install engrid-blenderscripts
The scripts will then be available at /usr/share/blender/scripts/engrid/. You will need to check the script installation instructions for the installed Blender version. For example, on Blender 2.6 you can install the scripts as add-ons, as described here: Installing Add-Ons in Blender

Recommended Method for Windows

Download and install the desired architecture version:

Alpha and Beta versions can be found https://sourceforge.net/projects/bluecfd-sc/files/enGrid-devbuilds/.

Other custom builds are described here.

General Building Instructions

Building enGrid is somewhat easy, but it's useful that the user already has some background in compiling and building software. The instructions provided here will not inform the user about every single aspect of building enGrid.

Since information about building enGrid can extend considerably, this subject will be divided into various topics.

Building enGrid on a Generic Linux System

This explains the general process of building enGrid on a Linux system:

  1. Install various packages as root. Keep in mind that names change depending on distribution and some you might have to build manually:
    git
    subversion
    wget
    gcc-c++
    vtk-qt
    qt-devel
    vtk-devel
    patch
  2. As normal user (not root), clone git repository and checkout branch release-1.4:
    1. You can use any single one of the following options:
      git clone git://github.com/enGits/engrid.git engrid
      git clone https://github.com/enGits/engrid.git engrid
      git clone git://repo.or.cz/engrid-github.git engrid
      git clone http://repo.or.cz/r/engrid-github.git engrid
    2. Go into enGrid's folder:
      cd engrid
    3. Checkout the release-1.4 branch:
      git checkout -b release-1.4 remotes/origin/release-1.4
    Note: If git isn't working for you, then you can download a snapshot of the release-1.4 branch: ZIP or TAR.GZ
  3. Go into the source code folder:
    cd src
  4. Set-up the environment variables, for which you need to adjust and execute the following two commands accordingly to your VTK installation:
    export VTKINCDIR=/usr/local/include/vtk
    export VTKLIBDIR=/usr/local/lib
  5. Build the NETGEN library:
    scripts/build-nglib.sh
  6. Build enGrid library and executable:
    qmake
    # Replace 4 with the number of cores your machine has
    make -j 4
  7. For running enGrid:
    ./start_engrid.bash
  8. Optional - to install an applications icon for the programs menu:
    • Either run from within the folder engrid this command as root:
      ./setup_generic.bash
    • Or create a shortcut yourself on the desired menu, pointing to the run.bash script. An icon is provided at engrid/src/libengrid/resources/icons/G.png.

Building enGrid on a Fedora System

  1. Install the various necessary packages, by running the following commands as root:
    yum install git
    yum install subversion
    yum install wget
    yum install gcc-c++
    yum install vtk-qt
    yum install qt-devel
    yum install vtk-devel
    yum install patch
    
  2. As normal user (not root), clone git repository and checkout branch release-1.4:
    1. You can use any single one of the following options:
      git clone git://github.com/enGits/engrid.git engrid
      git clone https://github.com/enGits/engrid.git engrid
      git clone git://repo.or.cz/engrid-github.git engrid
      git clone http://repo.or.cz/r/engrid-github.git engrid
    2. Go into enGrid's folder:
      cd engrid
    3. Checkout the release-1.4 branch:
      git checkout -b release-1.4 remotes/origin/release-1.4
    Note: If git isn't working for you, then you can download a snapshot of the release-1.4 branch: ZIP or TAR.GZ
  3. Go into the source code folder:
    cd src
  4. Set-up the environment variables, simply by running:
    source scripts/setup_pathes.bash
  5. Build the NETGEN library:
    scripts/build-nglib.sh
  6. Build enGrid library and executable:
    qmake
    # Replace 4 with the number of cores your machine has
    make -j 4
  7. For running enGrid:
    ./start_engrid.bash
  8. Optional - to install an applications icon for the programs menu:
    • Either run from within the folder engrid this command as root:
      ./setup_generic.bash
    • Or create a shortcut yourself on the desired menu, pointing to the run.bash script. An icon is provided at engrid/src/libengrid/resources/icons/G.png.

Building enGrid on an openSUSE 11.x or 12.x system

  1. Install the various necessary packages, by running the following commands as root:
    # Make sure to set the correct version number for the repository (i.e. 11.2, 11.3, 11.4, 12.1 or 12.2)
    zypper addrepo http://download.opensuse.org/repositories/science/openSUSE_11.4/ science
    zypper install git-core patch subversion libqt4-devel make vtk-qt vtk-devel
    
  2. As normal user (not root), clone git repository and checkout branch release-1.4:
    1. You can use any single one of the following options:
      git clone git://github.com/enGits/engrid.git engrid
      git clone https://github.com/enGits/engrid.git engrid
      git clone git://repo.or.cz/engrid-github.git engrid
      git clone http://repo.or.cz/r/engrid-github.git engrid
    2. Go into enGrid's folder:
      cd engrid
    3. Checkout the release-1.4 branch:
      git checkout -b release-1.4 remotes/origin/release-1.4
    Note: If git isn't working for you, then you can download a snapshot of the release-1.4 branch: ZIP or TAR.GZ
  3. Go into the source code folder:
    cd src
  4. Set-up the environment variables, simply by running:
    source scripts/setup_pathes.bash
  5. Build the NETGEN library:
    scripts/build-nglib.sh
  6. Build enGrid library and executable:
    qmake
    # Replace 4 with the number of cores your machine has
    make -j 4
  7. For running enGrid:
    ./start_engrid.bash
  8. Optional - to install an applications icon for the programs menu:
    • Either run from within the folder engrid this command as root:
      ./setup_generic.bash
    • Or create a shortcut yourself on the desired menu, pointing to the run.bash script. An icon is provided at engrid/src/libengrid/resources/icons/G.png.

Building enGrid on an Ubuntu system

  1. Make sure that the Universe repository is enabled: https://help.ubuntu.com/community/Repositories/Ubuntu
  2. Install the various necessary packages, by running the following command as root:
    sudo apt-get install git patch subversion g++ libvtk5-qt4-dev qt4-dev-tools
  3. As normal user (not root), clone git repository and checkout branch release-1.4:
    1. You can use any single one of the following options:
      git clone git://github.com/enGits/engrid.git engrid
      git clone https://github.com/enGits/engrid.git engrid
      git clone git://repo.or.cz/engrid-github.git engrid
      git clone http://repo.or.cz/r/engrid-github.git engrid
    2. Go into enGrid's folder:
      cd engrid
    3. Checkout the release-1.4 branch:
      git checkout -b release-1.4 remotes/origin/release-1.4
    Note: If git isn't working for you, then you can download a snapshot of the release-1.4 branch: ZIP or TAR.GZ
  4. Go into the source code folder:
    cd src
  5. Set-up the environment variables, simply by running:
    source scripts/setup_pathes.bash
  6. Build the NETGEN library:
    scripts/build-nglib.sh
  7. Build enGrid library and executable:
    qmake
    # Replace 4 with the number of cores your machine has
    make -j 4
  8. For running enGrid:
    ./start_engrid.bash
  9. Optional - to install an applications icon for the programs menu:
    • Either run from within the folder engrid this command as root:
      ./setup_generic.bash
    • Or create a shortcut yourself on the desired menu, pointing to the run.bash script. An icon is provided at engrid/src/libengrid/resources/icons/G.png.

Building enGrid on a Windows System

This topic is very extensive, therefore the detailed description on how to compile enGrid on a Windows system is provided here.

Clone this wiki locally