Difference between revisions of "Install"

Revision as of 14:48, 19 June 2015

Introduction

Even though AQUAgpusph can be compiled in a wide variety of Operating Systems, we are just officially supporting GNU/Linux based ones.

Precompiled packages

Currently AQUAgpusph is not providing precompiled packages.

Installing from the source code

AQUAgpusph-2.0

General

Currently AQUAgpusph-2.0 can be considered a stable version of AQUAgpusph, however several changes are becoming implemented and integrated, and therefore it is not a finished version (see #Subversion 2.1). Of course, AQUAgpusph-2.0 is the next release candidate, and it will be integrated in the master branch soon.

Downloading

To download AQUAgpusph-2.0 you must install [1] in your system. In GNU/Linux/Debian based Operating Systems you can type the following command (as superuser):

apt-get install git

After installing [2] in your system, you can download AQUAgpusph-2.0 typing (this time superuser is not required):

git clone -b 2.0 "https://github.com/sanguinariojoe/aquagpusph.git"

Installing dependencies

AQUAgpusph-2.0 has a number of dependencies that should be satisfied before compiling it:

• CMake
• Python
• NumPy
• Xerces-C
• OpenCL
• Eigen3
• libmatheval
• LLVM
• CLang

And some other that are not mandatory, but highly recommended (Some AQUAgpusph features are depending on them):

• Ncurses
• VTK

In GNU/Linux/Debian based Operating Systems they can be installed typing (as superuser):

apt-get install python-dev python-numpy libxerces-c-dev ocl-icd-opencl-dev libeigen3-dev libmatheval-dev llvm-3.4-dev libclang-dev

Compiling

AQUAgpusph can be compiled either in the 3D version (which will generate an executable called AQUAgpusph) or in the 2D one (which will generate an executable called AQUAgpusph2D). Both version can be compiled/installed in the same system, but during this document we are assuming that 3D version is selected (you can toggle to 2D version with -DAQUAGPUSPH_3D=OFF cmake flag).

Hence, to compile AQUAgpusph-2.0 (3D version) you can type (without superuser privileges):

cd aquapgusph && 
cmake -DAQUAGPUSPH_3D=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr . && 
make

Testing

AQUAgpusph can be tested without installing it, take a look on how to execute the dam-break example. Such example is using some additional software, see Suggested packages.

Installing

You can install AQUAgpusph executing as superuser the following command (execute it only if compilation process has gone right):

make install

It will install the software package in /usr/share/aquagpusph folder, the executable in /usr/bin, and the client and server libraries in /usr/lib.

Suggested packages

In addition to the dependencies discussed in Installing dependencies, there are some additional related software that you may want to install (some of these packages are used in the examples, for instance to plot results)

• ParaView
• matplotlib
• PyQt

In GNU/Linux/Debian based Operating Systems they can be installed by executing (as superuser):

apt-get install paraview python-matplotlib python-qt4

Subversion 2.1

The branch 2.1 is currently the most actively developed one, where the latest changes are implemented. When such changes become considered stable, they are merged into the root branch 2.0.

To download, compile, and install the branch AQUAgpusph-2.1 the same process described above should be applied, considering the following differences:

• To download the source code the following command will be typed:

git clone -b 2.1 "https://github.com/sanguinariojoe/aquagpusph.git"

• libmatheval dependency has been replaced by muparser. In GNU/Linux/Debian based Operating Systems it can be installed with the following command:

apt-get install muparser-dev