index.rst 3.58 KB
Newer Older
1
2
3
.. Command line options
   Matthieu Schaller, 21st October 2018

Mladen Ivkovic's avatar
Mladen Ivkovic committed
4
5
.. _cmdline-options:

6
7
8
Command line options
====================

Mladen Ivkovic's avatar
Mladen Ivkovic committed
9
10
11
12
13
SWIFT requires a number of runtime options to run and get any sensible output.
For instance, just running the ``swift`` binary will not use any SPH or gravity;
the particles will just sit still!

Below is a list of the command line options and when they should be used. The same list
14
can be found by typing ``./swift -h``::
Mladen Ivkovic's avatar
Mladen Ivkovic committed
15

16
17
18
    -h, --help                        show this help message and exit

  Simulation options:
19
20

    -b, --feedback                    Run with stars feedback.
21
    -c, --cosmology                   Run with cosmological time integration.
22
23
    --temperature                     Run with temperature calculation. 
    -C, --cooling                     Run with cooling (also switches on --with-temperature).
24
25
26
    -D, --drift-all                   Always drift all particles even the ones
                                      far from active particles. This emulates
                                      Gadget-[23] and GIZMO's default behaviours.
27
    -F, --star-formation	      Run with star formation.
28
29
30
    -g, --external-gravity            Run with an external gravitational potential.
    -G, --self-gravity                Run with self-gravity.
    -M, --multipole-reconstruction    Reconstruct the multipoles every time-step.
31
    -s, --hydro                       Run with hydrodynamics.
32
33
    -S, --stars                       Run with stars.
    -x, --velociraptor                Run with structure finding.
34
    --limiter                         Run with time-step limiter.
35
36

  Control options:
37

38
    -a, --pin                         Pin runners using processor affinity.
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    -d, --dry-run                     Dry run. Read the parameter file, allocates
                                      memory but does not read the particles
                                      from ICs. Exits before the start of time
                                      integration. Checks the validity of
                                      parameters and IC files as well as memory
                                      limits.
    -e, --fpe                         Enable floating-point exceptions (debugging
                                      mode).
    -f, --cpu-frequency=<str>         Overwrite the CPU frequency (Hz) to be
                                      used for time measurements.
    -n, --steps=<int>                 Execute a fixed number of time steps.
                                      When unset use the time_end parameter
                                      to stop.
    -o, --output-params=<str>         Generate a default output parameter
                                      file.
54
    -P, --param=<str>                 Set parameter value, overiding the value
55
56
57
58
59
60
61
62
63
64
65
66
                                      read from the parameter file. Can be used
                                      more than once {sec:par:value}.
    -r, --restart                     Continue using restart files.
    -t, --threads=<int>               The number of threads to use on each MPI
                                      rank. Defaults to 1 if not specified.
    -T, --timers=<int>                Print timers every time-step.
    -v, --verbose=<int>               Run in verbose mode, in MPI mode 2 outputs
                                      from all ranks.
    -y, --task-dumps=<int>            Time-step frequency at which task graphs
                                      are dumped.
    -Y, --threadpool-dumps=<int>      Time-step frequency at which threadpool
                                      tasks are dumped.