Commit 26c1d7b4 authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Documented the better way to compile VELOCIraptor in the RTD

parent 70f62467
......@@ -31,8 +31,11 @@ by doing::
Again we need to configure VELOCIraptor::
cmake . -DVR_USE_GAS=ON
cmake . -DVR_USE_HYDRO=ON -DCMAKE_BUILD_TYPE=Release
The first parameter activates the processing of gas, stars and black holes. It
can be omitted for simulations evolving only dark matter.
In this case, we do not need the SWIFT interface, therefore we can drop
this option (disabled by default).
......@@ -42,14 +45,14 @@ Compiling VELOCIraptor
Compiling goes completely different as compared to the on the fly halo finder
configuration with SWIFT. In this case we can compile the code as::
make
make -j
After this an executable is created (``VELOCIraptor-stf/stf``).
Running VELOCIraptor on a Snapshot
----------------------------------
After the code is compile the next step is using VELOCIraptor on a single
After the code has been compiled the next step is using VELOCIraptor on a single
snapshot of a simulation. The code has several options which can be used, which
can be displayed by running a terminal command of an invalid letter like::
......@@ -74,6 +77,6 @@ which gives the information about the usage of the command::
===== EXTRA OPTIONS REQUIRED FOR RAMSES INPUT ======
-t <ramses snapnumber>
After this we can run VELOCIraptor on a snapshot as::
After this we can run VELOCIraptor on a snapshot called ``input.hdf5`` as::
./stf -i input -o output -C configfile.txt
./stf -I 2 -i input -o output -C configfile.txt
......@@ -22,15 +22,19 @@ VELOCIraptor. This can be done by cloning the repository on GitHub_::
git clone https://github.com/pelahi/VELOCIraptor-STF
Currently the best version that works with SWIFT is the master
of VELOCIraptor, to get this branch use::
The SWIFT interface is in the master branch of VELOCIraptor so nothing is more
is needed besides fetching the latest version of the `NBodyLib` that the code
relies upon::
cd VELOCIraptor-STF
git fetch
To get VELOCIraptor working with SWIFT simply use::
cmake . -DVR_USE_SWIFT_INTERFACE=ON -DCMAKE_CXX_FLAGS="-fPIC" -DVR_USE_GAS=ON
cmake . -DVR_USE_HYDRO=ON -DVR_USE_SWIFT_INTERFACE=ON -DCMAKE_CXX_FLAGS="-fPIC" -DCMAKE_BUILD_TYPE=Release
The first parameter activates the processing of gas, stars and black holes. It
can be omitted for simulations evolving only dark matter.
If you wish to run swift without MPI, you will need to add ``-DVR_MPI=OFF``.
......@@ -40,7 +44,7 @@ Compiling VELOCIraptor
After we downloaded the files and made a configuration file we can compile
VELOCIraptor as follows::
make -j 4
make -j
After the compilation of your code, you will find a static library ``libvelociraptor.a``,
that is required to run SWIFT with VELOCIraptor.
......@@ -68,8 +72,8 @@ we first need to add several lines to the yaml file of our simulation
.. code:: YAML
StructureFinding:
config_file_name: stf_input_6dfof_dmonly_sub.cfg
basename: ./stf
config_file_name: vrconfig_3dfof_subhalos_SO_hydro.cfg
basename: haloes
scale_factor_first: 0.02
delta_time: 1.02
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment