gitlab is upgraded to version 13, please report any issues and enjoy

Commit 8bb43f1d authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Small updates to the VR-related documentation

parent e0750f24
......@@ -18,9 +18,9 @@ Setting up VELOCIraptor
-----------------------
The first step is setting up VELOCIraptor, this requires us to download the
git repository as::
git repository at::
git clone https://github.com/pelahi/VELOCIraptor-STF
git clone https://github.com/ICRAR/VELOCIraptor-STF.git
Similar to the SWIFT with VELOCIraptor configuration, we can use the
master to analyse individual snapshots. We can use this branch
......
......@@ -18,9 +18,9 @@ Setting up VELOCIraptor
-----------------------
Before we can run SWIFT with VELOCIraptor we first need to download
VELOCIraptor. This can be done by cloning the repository on GitHub_::
VELOCIraptor. This can be done by cloning the repository on GitHub::
git clone https://github.com/pelahi/VELOCIraptor-STF
git clone https://github.com/ICRAR/VELOCIraptor-STF.git
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
......@@ -54,7 +54,7 @@ HDF5 library, not a parallel build.
Compiling SWIFT
---------------
The next part is compiling SWIFT with VELOCIraptor and assumes you already
downloaded SWIFT from the GitLab_, this can be done by running
downloaded SWIFT from the GitLab repository. This can be done by running
.. code:: bash
......@@ -88,5 +88,4 @@ finder as::
Which activates the VELOCIraptor interface.
.. _GitHub: https://github.com/pelahi/VELOCIraptor-STF
.. _GitLab: https://gitlab.cosma.dur.ac.uk/swift/swiftsim
......@@ -10,19 +10,24 @@ What is VELOCIraptor?
:hidden:
:caption: Contents:
In SWIFT it is possible to run a cosmological simulation and at the same time
do on the fly halo finding at specific predefined intervals. For finding the
halos SWIFT uses VELOCIraptor (Elahi, Thacker and Widrow; 2011) [#velo]_, this
is a C++ halo finder that can use MPI. It differs from other halo finder
algorithms in the sense that it uses the velocity distributions of the
particles in the simulations and the the positions of the particles to get
a better estimate of which particles are part of a specific halo and
whether there are substructures in halos.
In SWIFT it is possible to run a cosmological simulation and at the same time do
on the fly halo finding at specific predefined intervals. For finding the halos
SWIFT uses VELOCIraptor (See `Elahi, Thacker and Widrow (2011)
<https://ui.adsabs.harvard.edu/abs/2011MNRAS.418..320E>`_ and `Elahi et
al. (2019) <https://ui.adsabs.harvard.edu/abs/2019PASA...36...21E/abstract>`_),
this is a C++ halo finder that can use MPI. It differs from other halo finder
algorithms in the sense that it uses the velocity distributions of the particles
in the simulations and the the positions of the particles to get a better
estimate of which particles are part of a specific halo and whether there are
substructures in halos. The code is hosted and maintained publicly by the theory
group at `ICRAR <https://www.icrar.org>`_ on their GitHub `repository
<https://github.com/ICRAR/VELOCIraptor-STF>`_.
The Algorithm
-------------
The VELOCIraptor algorithm consists basically of the following steps [#ref]_:
The VELOCIraptor algorithm consists basically of the following steps (See papers
for details):
1. A kd-tree is constructed based on the maximization of the Shannon-entropy,
this means that every level in the kd-tree an equal number of particles
......@@ -58,8 +63,3 @@ The VELOCIraptor algorithm consists basically of the following steps [#ref]_:
is most sensitive for subhalos which are cold (slow rotating) but have
a large bulk velocity
.. _Velociraptor: http://adsabs.harvard.edu/abs/2011MNRAS.418..320E
.. [#velo] For technical information regarding VELOCIraptor see: Velociraptor_
.. [#ref] This part is based on the explanation given in the Elahi, Thacker and
Widrow (2011) paper (Velociraptor_)
Markdown is supported
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