Difference between revisions of "Install"
m (Added version to LLVM and CLang dependencies) |
m (Moving to AQUAgpusph-2 as the latest stable release) |
||
Line 9: | Line 9: | ||
== Installing from the source code == | == Installing from the source code == | ||
− | === AQUAgpusph-2 | + | === AQUAgpusph-2 === |
==== General ==== | ==== General ==== | ||
− | + | AQUAgpusph-2 is the last stable version of AQUAgpusph, however several changes are becoming implemented and integrated (see [[#AQUAgpusph-2.2]]). | |
==== Downloading ==== | ==== Downloading ==== | ||
− | To download AQUAgpusph-2 | + | To download AQUAgpusph-2 you must install [http://git-scm.com/:Git] in your system. In [https://www.gnu.org GNU]/[http://www.linux.com Linux]/[https://www.debian.org/ Debian] based Operating Systems you can type the following command (as superuser): |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
Line 23: | Line 23: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | After installing [http://git-scm.com/:Git] in your system, you can download AQUAgpusph-2 | + | After installing [http://git-scm.com/:Git] in your system, you can download AQUAgpusph-2 typing (this time superuser is not required): |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
− | git clone | + | git clone "https://github.com/sanguinariojoe/aquagpusph.git" |
</syntaxhighlight> | </syntaxhighlight> | ||
==== Installing dependencies ==== | ==== Installing dependencies ==== | ||
− | AQUAgpusph-2 | + | AQUAgpusph-2 has a number of dependencies that should be satisfied before compiling it: |
* [http://www.cmake.org CMake] | * [http://www.cmake.org CMake] | ||
Line 38: | Line 38: | ||
* [http://xerces.apache.org/xerces-c Xerces-C] | * [http://xerces.apache.org/xerces-c Xerces-C] | ||
* [http://www.khronos.org/opencl OpenCL] | * [http://www.khronos.org/opencl OpenCL] | ||
+ | * [http://muparser.beltoforion.de muparser] | ||
* [http://eigen.tuxfamily.org Eigen3] | * [http://eigen.tuxfamily.org Eigen3] | ||
* [http://www.gnu.org/software/libmatheval libmatheval] | * [http://www.gnu.org/software/libmatheval libmatheval] | ||
Line 46: | Line 47: | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
− | apt-get install python-dev python-numpy libxerces-c-dev ocl-icd-opencl-dev libeigen3-dev | + | apt-get install python-dev python-numpy libxerces-c-dev ocl-icd-opencl-dev libeigen3-dev muparser-dev llvm-dev libclang-dev |
</syntaxhighlight> | </syntaxhighlight> | ||
Line 64: | Line 65: | ||
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, but during this document we are assuming that 3D version is selected (you can toggle to 2D version with -DAQUAGPUSPH_3D=OFF cmake flag). | 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, 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 | + | Hence, to compile AQUAgpusph-2 (3D version) you can type (without superuser privileges): |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
Line 84: | Line 85: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | It | + | It is installing the software package at /usr/share/aquagpusph folder, the executable at /usr/bin, and the client and server libraries at /usr/lib. |
==== Suggested packages ==== | ==== Suggested packages ==== | ||
Line 100: | Line 101: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | ==== Subversion 2. | + | ==== Subversion 2.2 ==== |
− | The branch 2. | + | The branch 2.2 is currently under heavy development. In such branch several fixes to AQUAgpusph-2 will be implemented. |
− | To download, compile, and install the branch AQUAgpusph-2. | + | To download, compile, and install the branch AQUAgpusph-2.2 the same process described above should be applied, considering the following differences: |
* To download the source code the following command will be typed: | * To download the source code the following command will be typed: | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
− | git clone -b 2. | + | git clone -b 2.2 "https://github.com/sanguinariojoe/aquagpusph.git" |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</syntaxhighlight> | </syntaxhighlight> |
Revision as of 22:24, 7 December 2015
Contents
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
General
AQUAgpusph-2 is the last stable version of AQUAgpusph, however several changes are becoming implemented and integrated (see #AQUAgpusph-2.2).
Downloading
To download AQUAgpusph-2 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 typing (this time superuser is not required):
git clone "https://github.com/sanguinariojoe/aquagpusph.git"
Installing dependencies
AQUAgpusph-2 has a number of dependencies that should be satisfied before compiling it:
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 muparser-dev llvm-dev libclang-dev
There are also some other non-mandatory (but highly recommended) dependencies:
Such optional dependencies can be installed with the following command (take care, the versions may change):
apt-get install libncurses5-dev libvtk5-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 versions 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 (3D version) you can type (without superuser privileges):
cd aquagpusph && 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 finished without errors):
make install
It is installing the software package at /usr/share/aquagpusph folder, the executable at /usr/bin, and the client and server libraries at /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)
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.2
The branch 2.2 is currently under heavy development. In such branch several fixes to AQUAgpusph-2 will be implemented.
To download, compile, and install the branch AQUAgpusph-2.2 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.2 "https://github.com/sanguinariojoe/aquagpusph.git"