From 7d9f4b301e5207edee036c98042a40b08fe25d9e Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <schaller@strw.leidenuniv.nl>
Date: Sat, 12 Jan 2019 21:34:55 +0100
Subject: [PATCH] Added description of the EAGLE tracers to the RTD.

---
 doc/RTD/source/SubgridModels/EAGLE/index.rst | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/doc/RTD/source/SubgridModels/EAGLE/index.rst b/doc/RTD/source/SubgridModels/EAGLE/index.rst
index 817350c30b..639d98cd1a 100644
--- a/doc/RTD/source/SubgridModels/EAGLE/index.rst
+++ b/doc/RTD/source/SubgridModels/EAGLE/index.rst
@@ -255,7 +255,25 @@ Particle tracers
 Over the course of the simulation, the gas particles record some information
 about their evolution. These are updated for a given particle every time it is
 active. The EAGLE tracers module is located in the directory
-``src/tracers/EAGLE``. 
+``src/tracers/EAGLE/``. 
+
+In the EAGLE model, we trace the maximal tempearature a particle has reached and
+the time at which this happened. When a star is formed (see the section
+:ref:`EAGLE_star_formation` below), it inherits all the tracer values of its parent
+gas particle.  There are no parameters to the model but two values are added to
+the snapshots for each gas and star particle:
+
++----------------------------------------+---------------------------------------+-----------+-----------------------------+
+| Name                                   | Description                           | Units     | Comments                    |
++========================================+=======================================+===========+=============================+
+| | ``Maximal Temperature``              | | Mximal temperature reached by       | | [U_T]   |                             |
+|                                        | | this particle.                      |           |                             |
++----------------------------------------+---------------------------------------+-----------+-----------------------------+
+| | ``Maximal Temperature scale-factor`` | | Scale-factor (cosmological runs)    | | [-]     |                             |
+| | OR                                   | | or time (non-cosmological runs) at  | | OR      |                             |
+| | ``Maximal Temperature time``         | | which the maximum value was reached.| | [U_t]   |                             |
++----------------------------------------+---------------------------------------+-----------+-----------------------------+
+
 
 .. _EAGLE_star_formation:
 
-- 
GitLab