Skip to content
Snippets Groups Projects
Commit 21eba125 authored by Josh Borrow's avatar Josh Borrow
Browse files

Added double back ticks for RST

parent 6ee64b52
No related branches found
No related tags found
1 merge request!555Add select output documentation
...@@ -4,16 +4,23 @@ ...@@ -4,16 +4,23 @@
Parameter File Parameter File
============== ==============
To run SWIFT, you will need to provide a `yaml` parameter file. To run SWIFT, you will need to provide a ``yaml`` parameter file. An example is
An example is given in `examples/parameter_file.yml` which should contain all possible parameters. given in ``examples/parameter_file.yml`` which should contain all possible
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. 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 Selection Output Selection
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
With SWIFT, you can select the output in the parameter file. With SWIFT, you can select the output in the parameter file. In section
In section `SelectOutput`, you can remove a field by adding a parameter formatted in the following way `field_parttype` where `field` is the name of the field that you want to remove (e.g. `Masses`) and `parttype` is the type of particles that contains this field (e.g. `Gas`, `DM` or `Star`). ``SelectOutput``, you can remove a field by adding a parameter formatted in the
For a parameter, the only values accepted are 0 (skip this field when writing) or 1 (default, do not skip this field when writing). following way ``field_parttype`` where ``field`` is the name of the field that you
want to remove (e.g. ``Masses``) and ``parttype`` is the type of particles that
contains this field (e.g. ``Gas``, ``DM`` or ``Star``). For a parameter, the only
values accepted are 0 (skip this field when writing) or 1 (default, do not skip
this field when writing).
You can generate a `yaml` file containing all the possible fields with `./swift -o output.yml`. You can generate a ``yaml`` file containing all the possible fields with ``./swift
-o output.yml``.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment