install

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

Latest version

General

AQUAgpusph, and SPH methodology in general, is still in heavily development, and therefore the latest "master" version, is always recommended. Indeed, such version has the newest features, becoming unfortunately more prone to bugs.

Downloading

To download AQUAgpusph you must install Git in your system, an excellent free and open source distributed version control system. In GNU/Linux/Debian based Operating Systems you can type the following command (as superuser):

apt-get install git

While in GNU/Linux/Arch based systems you can type:

pacman -Suy git

After installing Git in your system, you can download AQUAgpusph typing (this time superuser is not required):

git clone "https://gitlab.com/sanguinariojoe/aquagpusph.git"

which will create an aquagpusph folder, will all the sources inside.

Installing dependencies

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

• CMake
• Python
• NumPy
• Xerces-C
• OpenCL
• muparser
• Eigen3
• LLVM (>= 3.5)
• CLang (>= 3.5)
• VTK (Optional, but strongly recommended)
• Ncurses (Optional)
• ParaView (Optional)
• matplotlib (Optional)

Almost all the dependencies can be installed by means of the package manager of your favorite GNU/Linux distribution.

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 versions can be compiled/installed in the same system. To this end you can type (without superuser privileges):

mkdir aquagpusph.gcc &&
cd aquagpusph.gcc &&
cmake -DAQUAGPUSPH_3D=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr ../aquagpusph && 
make &&
cmake -DAQUAGPUSPH_3D=OFF -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr ../aquagpusph && 
make

which will create an aquagpusph.gcc folder, besides the original sources one, aquagpusph. Both 3D and 2D executables can be found in the bin/.

Note

Since AQUAgpusph 4.1.0 in-source buildings are disabled.

Note for developers

AQUAgpusph tests can be executed typing make test

Testing

AQUAgpusph can be tested without installing it, take a look on how to execute the dam-break example.

Installing

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

make install

Which is installing the software package at /usr/share/aquagpusph folder, the executable at /usr/bin, and the libraries at /usr/lib.

Old versions

Several stable versions of AQUAgpusph have been released in the past, that can be downloaded. You are warned that, due to the fast evolution of AQUAgpusph, its dependencies and the SPH methodology in general, such versions may not work fine with latest GNU/Linux Distributions, or have several inconsistencies in the formulation implemented.

The old versions are stored in Git tags, such that the same process described above can be followed, changing to the convenient branch before compiling the package.

You can learn more about the Git tags here.