Skip to content
Snippets Groups Projects
Commit 4ff124be authored by Peter W. Draper's avatar Peter W. Draper
Browse files

Update documentation to show long options in preference to short ones

parent 8075f53c
No related branches found
No related tags found
1 merge request!689Add GNU style long command line arguments
Hide whitespace changes
Inline Side-by-side
Showing
with 64 additions and 66 deletions
README
+ 45
− 45
View file @ 4ff124be
Welcome to the cosmological hydrodynamical code
______ _________________
/ ___/ | / / _/ ___/_ __/
\__ \| | /| / // // /_ / /
___/ /| |/ |/ // // __/ / /
/____/ |__/|__/___/_/ /_/
\__ \| | /| / // // /_ / /
___/ /| |/ |/ // // __/ / /
/____/ |__/|__/___/_/ /_/
SPH With Inter-dependent Fine-grained Tasking
Website: www.swiftsim.com
......@@ -18,52 +18,52 @@ Usage: swift [options] [[--] param-file]
Parameters:
-h, --help show this help message and exit
-h, --help show this help message and exit
Simulation options:
-b, --feedback Run with stars feedback
-c, --cosmology Run with cosmological time integration.
-C, --cooling Run with cooling
-b, --feedback Run with stars feedback
-c, --cosmology Run with cosmological time integration.
-C, --cooling Run with cooling
-D, --drift-all Always drift all particles even the ones
far from active particles. This emulates
Gadget-[23] and GIZMO's default behaviours.
-F, --sourceterms
-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.
-s, --hydrodynamics Run with hydrodynamics.
-S, --stars Run with stars
-x, --velociraptor Run with structure finding
-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.
-s, --hydro Run with hydrodynamics.
-S, --stars Run with stars
-x, --velociraptor Run with structure finding
Control options:
-a, --affinity Pin runners using processor affinity.
-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.
-D, --drift-all Always drift all particles even the ones
far from active particles. This emulates
Gadget-[23] and GIZMO's default behaviours.
-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.
-P, --param=<str> Set parameter value, overwriting a value
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.
-a, --pin Pin runners using processor affinity.
-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.
-P, --param=<str> Set parameter value, overiding the value
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.
See the file examples/parameter_example.yml for an example of parameter file.
README.md
+ 6
− 6
View file @ 4ff124be
......@@ -72,25 +72,25 @@ Parameters:
-b, --feedback Run with stars feedback
-c, --cosmology Run with cosmological time integration.
-C, --cooling Run with cooling
-D, --drift-all Always drift all particles even the ones
far from active particles. This emulates
Gadget-[23] and GIZMO's default behaviours.
-F, --sourceterms
-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.
-s, --hydrodynamics Run with hydrodynamics.
-s, --hydro Run with hydrodynamics.
-S, --stars Run with stars
-x, --velociraptor Run with structure finding
Control options:
-a, --affinity Pin runners using processor affinity.
-a, --pin Pin runners using processor affinity.
-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.
-D, --drift-all Always drift all particles even the ones
far from active particles. This emulates
Gadget-[23] and GIZMO's default behaviours.
-e, --fpe Enable floating-point exceptions (debugging
mode).
-f, --cpu-frequency=<str> Overwrite the CPU frequency (Hz) to be
......@@ -100,7 +100,7 @@ Parameters:
to stop.
-o, --output-params=<str> Generate a default output parameter
file.
-P, --param=<str> Set parameter value, overwriting a value
-P, --param=<str> Set parameter value, overiding the value
read from the parameter file. Can be used
more than once {sec:par:value}.
-r, --restart Continue using restart files.
......
doc/RTD/source/CommandLineOptions/index.rst
+ 6
− 7
View file @ 4ff124be
......@@ -19,25 +19,25 @@ can be found by typing ``./swift -h``::
-b, --feedback Run with stars feedback
-c, --cosmology Run with cosmological time integration.
-C, --cooling Run with cooling
-D, --drift-all Always drift all particles even the ones
far from active particles. This emulates
Gadget-[23] and GIZMO's default behaviours.
-F, --sourceterms
-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.
-s, --hydrodynamics Run with hydrodynamics.
-s, --hydro Run with hydrodynamics.
-S, --stars Run with stars
-x, --velociraptor Run with structure finding
Control options:
-a, --affinity Pin runners using processor affinity.
-a, --pin Pin runners using processor affinity.
-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.
-D, --drift-all Always drift all particles even the ones
far from active particles. This emulates
Gadget-[23] and GIZMO's default behaviours.
-e, --fpe Enable floating-point exceptions (debugging
mode).
-f, --cpu-frequency=<str> Overwrite the CPU frequency (Hz) to be
......@@ -47,7 +47,7 @@ can be found by typing ``./swift -h``::
to stop.
-o, --output-params=<str> Generate a default output parameter
file.
-P, --param=<str> Set parameter value, overwriting a value
-P, --param=<str> Set parameter value, overiding the value
read from the parameter file. Can be used
more than once {sec:par:value}.
-r, --restart Continue using restart files.
......@@ -60,4 +60,3 @@ can be found by typing ``./swift -h``::
are dumped.
-Y, --threadpool-dumps=<int> Time-step frequency at which threadpool
tasks are dumped.
doc/RTD/source/GettingStarted/running_example.rst
+ 1
− 1
View file @ 4ff124be
......@@ -14,7 +14,7 @@ as ``wget`` for grabbing the glass).
cd examples/SodShock_3D
./getGlass.sh
python makeIC.py
../swift -s -t 4 sodShock.yml
../swift --hydro --threads=4 sodShock.yml
python plotSolution.py 1
......
doc/RTD/source/GettingStarted/running_on_large_systems.rst
+ 1
− 1
View file @ 4ff124be
......@@ -38,5 +38,5 @@ each with 2x16 core processors for a total of 512 cores):
#SBATCH -N 16 # Number of nodes to run on
#SBATCH --tasks-per-node=2 # This system has 2 chips per node
mpirun -np 32 swift_mpi -t 16 -a parameter.yml
mpirun -np 32 swift_mpi --threads=16 --pin parameter.yml
doc/RTD/source/ParameterFiles/output_selection.rst
+ 3
− 3
View file @ 4ff124be
......@@ -37,7 +37,7 @@ Example of file with redshift::
5
.. _Output_selection_label:
Output Selection
~~~~~~~~~~~~~~~~
......@@ -59,7 +59,7 @@ waste of disk space. The corresponding section of the ``yaml``
parameter file would look like this::
SelectOutput:
Masses_DM: 0
Masses_DM: 0
You can generate a ``yaml`` file containing all the possible fields
available for a given configuration of SWIFT by running ``./swift -o output.yml``.
available for a given configuration of SWIFT by running ``./swift --output-params output.yml``.
doc/RTD/source/VELOCIraptorInterface/stfwithswift.rst
+ 2
− 3
View file @ 4ff124be
......@@ -85,10 +85,9 @@ the Small Cosmological Volume DMO example we can run a simulation with halo
finder as::
cd examples/SmallCosmoVolume_DM
../swift -c -s -G -x -t 8 small_cosmo_volume_dm.yml
../swift --cosmology --hydro --self-gravity --velociraptor --threads=8 small_cosmo_volume_dm.yml
In which there is an additional ``-x`` option which activates the VELOCIraptor
interface.
Which activates the VELOCIraptor interface.
.. _GitHub: https://github.com/pelahi/VELOCIraptor-STF
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment