From 76e1bb89a34df8b19735025f04eb3676b161f6da Mon Sep 17 00:00:00 2001 From: Josh Borrow <joshua.borrow@durham.ac.uk> Date: Fri, 9 Nov 2018 09:20:59 +0000 Subject: [PATCH] Minor documenation update for velociraptor output --- doc/RTD/source/VELOCIraptorInterface/output.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/RTD/source/VELOCIraptorInterface/output.rst b/doc/RTD/source/VELOCIraptorInterface/output.rst index 5a7073da17..b903a65012 100644 --- a/doc/RTD/source/VELOCIraptorInterface/output.rst +++ b/doc/RTD/source/VELOCIraptorInterface/output.rst @@ -23,7 +23,10 @@ group sizes, the interesting data in the ``.catalog_group`` files are: + The ``group_size``: gives a list of all the halos and the number of particles in the halo, this list is numbered from 0 until the number of groups minus - one. It is important that the groups are not ordered in any way [#order]_ + one. It is important that the groups are not ordered in any way [#order]_. + It is also important to note that the group size includes both the bound and + unbound particles; always use the ``Offset`` and ``Offset_unbound`` data + when reading from the ``catalog_particles`` files. + The ``Num_of_groups`` or ``Total_num_of_groups``: gives the total number of groups in the snapshot. + The ``Offset`` list: This list gives the offset off the particles. In the -- GitLab