Difference between revisions of "Install"
m (Documented the installation) |
m |
||
| Line 64: | Line 64: | ||
==== Testing ==== | ==== Testing ==== | ||
| − | AQUAgpusph can be tested without installing it, take a look on how to execute the [[examples/3D/spheric_testcase2_dambreak dam-break example]]. Such example is using some additional software, see [[#Suggested packages]]. | + | AQUAgpusph can be tested without installing it, take a look on how to execute the [[examples/3D/spheric_testcase2_dambreak dam-break example]]. Such example is using some additional software, see [[#Suggested packages|Suggested packages]]. |
==== Installing ==== | ==== Installing ==== | ||
| Line 78: | Line 78: | ||
==== Suggested packages ==== | ==== 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 addition to the dependencies discussed in [[#Installing dependencies|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) |
* [http://www.paraview.org ParaView] | * [http://www.paraview.org ParaView] | ||
Revision as of 18:18, 11 March 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.0
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:
And some other that are not mandatory, but highly recommended (Some AQUAgpusph features are depending on them):
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 examples/3D/spheric_testcase2_dambreak 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)
In GNU/Linux/Debian based Operating Systems they can be installed by executing (as superuser):
apt-get install paraview python-matplotlib python-qt4
