diff --git a/doc/RTD/source/SubgridModels/GEAR/index.rst b/doc/RTD/source/SubgridModels/GEAR/index.rst index 152056ef2eb60da189bf18b3b3c9909f88ace6de..8ae907a87f473b543bc5c487c3a82aef0387f5b2 100644 --- a/doc/RTD/source/SubgridModels/GEAR/index.rst +++ b/doc/RTD/source/SubgridModels/GEAR/index.rst @@ -37,8 +37,8 @@ Grackle is a chemistry and cooling library presented in `B. Smith et al. 2016 <h equilibrium, 6 species network (H, H\\( ^+ \\), e\\( ^- \\), He, He\\( ^+ \\) and He\\( ^{++} \\)), 9 species network (adds H\\(^-\\), H\\(_2\\) and H\\(_2^+\\)) and 12 species (adds D, D\\(^+\\) and HD). Following the same -order, the swift cooling options are ``grackle``, ``grackle1``, ``grackle2`` -and ``grackle3`` (the numbers correspond to the value of +order, the swift cooling options are ``grackle_0``, ``grackle_1``, ``grackle_2`` +and ``grackle_3`` (the numbers correspond to the value of ``primordial_chemistry`` in Grackle). It also includes some self-shielding methods and UV background. In order to use the Grackle cooling, you will need to provide an HDF5 table computed by Cloudy. @@ -46,8 +46,8 @@ to provide an HDF5 table computed by Cloudy. When starting a simulation without providing the different fractions, the code supposes an equilibrium and computes the fractions automatically. -In order to compile SWIFT with Grackle, you need to provide the options ``with-grackle`` -and ``with-chemistry``. +In order to compile SWIFT with Grackle, you need to provide the options ``with-chemistry=GEAR`` and ``with-grackle=$GRACKLE_ROOT`` +where ``$GRACKLE_ROOT`` is the root of the install directory (not the ``lib``). You will need a Grackle version later than 3.1. To compile it, run the following commands from the root directory of Grackle: