diff --git a/doc/RTD/source/GettingStarted/index.rst b/doc/RTD/source/GettingStarted/index.rst index 36de8ea740490c16bc9d6b69d871290e80dc2091..2086bcfb4af0ac1b7bbc24c34caa85fa1ebec498 100644 --- a/doc/RTD/source/GettingStarted/index.rst +++ b/doc/RTD/source/GettingStarted/index.rst @@ -20,7 +20,6 @@ and keep on your desk. running_example runtime_options configuration_options - parameter_file what_about_mpi running_on_large_systems special_modes diff --git a/doc/RTD/source/ParameterFiles/index.rst b/doc/RTD/source/ParameterFiles/index.rst index 481c7e11792ee3503cf86ce70294ef5c0077e0cb..7ad85c6a4e856f39abd1d9584e5ff4df9578ae6d 100644 --- a/doc/RTD/source/ParameterFiles/index.rst +++ b/doc/RTD/source/ParameterFiles/index.rst @@ -145,7 +145,8 @@ of units. Setting a value of `1` when using the system of units (10^10 Msun, Mpc, km/s) will mean that :math:`G_N=1` in these units [#f2]_ instead of the normal value :math:`G_N=43.00927`. -This option is only used for specific tests and debugging. +This option is only used for specific tests and debugging. This entire +section of the YAML file can typically be left out. Cosmology @@ -180,7 +181,7 @@ If unspecified these parameters default to the default :math:`\Lambda\rm{CDM}` values of :math:`w_0 = -1` and :math:`w_a = 0`. For a Planck+13 cosmological model (ignoring radiation density as is -commonly done and running from :math:`z=127` to :math:`z=0`, one would hence +commonly done) and running from :math:`z=127` to :math:`z=0`, one would hence use the following parameters: .. code:: YAML @@ -209,6 +210,14 @@ TimeIntegration Snapshots --------- +Some additional specific options for the snapshot outputs are described in the +following pages: + +.. toctree:: + :maxdepth: 1 + + output_selection + Statistics ---------- diff --git a/doc/RTD/source/GettingStarted/parameter_file.rst b/doc/RTD/source/ParameterFiles/output_selection.rst similarity index 69% rename from doc/RTD/source/GettingStarted/parameter_file.rst rename to doc/RTD/source/ParameterFiles/output_selection.rst index 550040ed25ec307633d6fade81eced58ed65a254..ca905c5e613082cdf9de9db718bdd16c4a3c8951 100644 --- a/doc/RTD/source/GettingStarted/parameter_file.rst +++ b/doc/RTD/source/ParameterFiles/output_selection.rst @@ -1,23 +1,17 @@ .. Parameter File Loic Hausammann, 1 june 2018 -.. _Parameter_File_label: - -Parameter File -============== - -To run SWIFT, you will need to provide a ``yaml`` parameter file. An example is -given in ``examples/parameter_file.yml`` which should contain all possible -parameters. Each section in this file corresponds to a different option in -SWIFT and are not always required depending on the configuration options and -the run time parameters. +.. _Output_list_label: Output List ~~~~~~~~~~~ -In the sections ``Snapshots`` and ``Statistics``, you can specify the options ``output_list_on`` and ``output_list`` which receive an int and a filename. -The ``output_list_on`` enable or not the output list and ``output_list`` is the filename containing the output times. -With the file header, you can choose between writing redshifts, scale factors or times. +In the sections ``Snapshots`` and ``Statistics``, you can specify the +options ``output_list_on`` and ``output_list`` which receive an int +and a filename. The ``output_list_on`` enable or not the output list +and ``output_list`` is the filename containing the output times. With +the file header, you can choose between writing redshifts, scale +factors or times. Example of file containing with times (in internal units):: @@ -42,6 +36,8 @@ Example of file with redshift:: 10 5 +.. _Output_selection_label: + Output Selection ~~~~~~~~~~~~~~~~