Commit 3046b295 authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Updated README and help message to account for latest changes.

parent 7c7ac4d8
...@@ -15,25 +15,26 @@ Usage: swift [OPTION]... PARAMFILE ...@@ -15,25 +15,26 @@ Usage: swift [OPTION]... PARAMFILE
swift_mpi [OPTION]... PARAMFILE swift_mpi [OPTION]... PARAMFILE
Valid options are: Valid options are:
-a Pin runners using processor affinity -a Pin runners using processor affinity.
-c Run with cosmological time integration -c Run with cosmological time integration.
-C Run with cooling -C Run with cooling.
-d Dry run. Read the parameter file, allocate memory but does not read -d Dry run. Read the parameter file, allocate memory but does not read
the particles from ICs and exit before the start of time integration. the particles from ICs and exit before the start of time integration.
Allows user to check validy of parameter and IC files as well as memory limits. Allows user to check validy of parameter and IC files as well as memory limits.
-D Always drift all particles even the ones far from active particles. -D Always drift all particles even the ones far from active particles. This emulates
-e Enable floating-point exceptions (debugging mode) Gadget-[23] and GIZMO's default behaviours.
-f {int} Overwrite the CPU frequency (Hz) to be used for time measurements -e Enable floating-point exceptions (debugging mode).
-g Run with an external gravitational potential -f {int} Overwrite the CPU frequency (Hz) to be used for time measurements.
-G Run with self-gravity -g Run with an external gravitational potential.
-G Run with self-gravity.
-n {int} Execute a fixed number of time steps. When unset use the time_end parameter to stop. -n {int} Execute a fixed number of time steps. When unset use the time_end parameter to stop.
-s Run with SPH -s Run with hydrodynamics.
-S Run with stars -S Run with stars.
-t {int} The number of threads to use on each MPI rank. Defaults to 1 if not specified. -t {int} The number of threads to use on each MPI rank. Defaults to 1 if not specified.
-v [12] Increase the level of verbosity -v [12] Increase the level of verbosity
1: MPI-rank 0 writes 1: MPI-rank 0 writes
2: All MPI-ranks write 2: All MPI-ranks write
-y {int} Time-step frequency at which task graphs are dumped -y {int} Time-step frequency at which task graphs are dumped.
-h Print this help message and exit -h Print this help message and exit.
See the file examples/parameter_example.yml for an example of parameter file. See the file examples/parameter_example.yml for an example of parameter file.
...@@ -57,9 +57,9 @@ void print_help_message() { ...@@ -57,9 +57,9 @@ void print_help_message() {
printf(" swift_mpi [OPTION]... PARAMFILE\n\n"); printf(" swift_mpi [OPTION]... PARAMFILE\n\n");
printf("Valid options are:\n"); printf("Valid options are:\n");
printf(" %2s %8s %s\n", "-a", "", "Pin runners using processor affinity"); printf(" %2s %8s %s\n", "-a", "", "Pin runners using processor affinity.");
printf(" %2s %8s %s\n", "-c", "", "Run with cosmological time integration"); printf(" %2s %8s %s\n", "-c", "", "Run with cosmological time integration.");
printf(" %2s %8s %s\n", "-C", "", "Run with cooling"); printf(" %2s %8s %s\n", "-C", "", "Run with cooling.");
printf( printf(
" %2s %8s %s\n", "-d", "", " %2s %8s %s\n", "-d", "",
"Dry run. Read the parameter file, allocate memory but does not read "); "Dry run. Read the parameter file, allocate memory but does not read ");
...@@ -70,29 +70,32 @@ void print_help_message() { ...@@ -70,29 +70,32 @@ void print_help_message() {
"Allows user to check validy of parameter and IC files as well as " "Allows user to check validy of parameter and IC files as well as "
"memory limits."); "memory limits.");
printf(" %2s %8s %s\n", "-D", "", printf(" %2s %8s %s\n", "-D", "",
"Always drift all particles even the ones far from active particles."); "Always drift all particles even the ones far from active particles. "
"This emulates");
printf(" %2s %8s %s\n", "", "",
"Gadget-[23] and GIZMO's default behaviours.");
printf(" %2s %8s %s\n", "-e", "", printf(" %2s %8s %s\n", "-e", "",
"Enable floating-point exceptions (debugging mode)"); "Enable floating-point exceptions (debugging mode).");
printf(" %2s %8s %s\n", "-f", "{int}", printf(" %2s %8s %s\n", "-f", "{int}",
"Overwrite the CPU frequency (Hz) to be used for time measurements"); "Overwrite the CPU frequency (Hz) to be used for time measurements.");
printf(" %2s %8s %s\n", "-g", "", printf(" %2s %8s %s\n", "-g", "",
"Run with an external gravitational potential"); "Run with an external gravitational potential.");
printf(" %2s %8s %s\n", "-F", "", "Run with feedback "); printf(" %2s %8s %s\n", "-F", "", "Run with feedback.");
printf(" %2s %8s %s\n", "-G", "", "Run with self-gravity"); printf(" %2s %8s %s\n", "-G", "", "Run with self-gravity.");
printf(" %2s %8s %s\n", "-n", "{int}", printf(" %2s %8s %s\n", "-n", "{int}",
"Execute a fixed number of time steps. When unset use the time_end " "Execute a fixed number of time steps. When unset use the time_end "
"parameter to stop."); "parameter to stop.");
printf(" %2s %8s %s\n", "-s", "", "Run with SPH"); printf(" %2s %8s %s\n", "-s", "", "Run with hydrodynamics.");
printf(" %2s %8s %s\n", "-S", "", "Run with stars"); printf(" %2s %8s %s\n", "-S", "", "Run with stars.");
printf(" %2s %8s %s\n", "-t", "{int}", printf(" %2s %8s %s\n", "-t", "{int}",
"The number of threads to use on each MPI rank. Defaults to 1 if not " "The number of threads to use on each MPI rank. Defaults to 1 if not "
"specified."); "specified.");
printf(" %2s %8s %s\n", "-v", "[12]", "Increase the level of verbosity"); printf(" %2s %8s %s\n", "-v", "[12]", "Increase the level of verbosity.");
printf(" %2s %8s %s\n", "", "", "1: MPI-rank 0 writes "); printf(" %2s %8s %s\n", "", "", "1: MPI-rank 0 writes ");
printf(" %2s %8s %s\n", "", "", "2: All MPI-ranks write"); printf(" %2s %8s %s\n", "", "", "2: All MPI-ranks write");
printf(" %2s %8s %s\n", "-y", "{int}", printf(" %2s %8s %s\n", "-y", "{int}",
"Time-step frequency at which task graphs are dumped"); "Time-step frequency at which task graphs are dumped.");
printf(" %2s %8s %s\n", "-h", "", "Print this help message and exit"); printf(" %2s %8s %s\n", "-h", "", "Print this help message and exit.");
printf( printf(
"\nSee the file parameter_example.yml for an example of " "\nSee the file parameter_example.yml for an example of "
"parameter file.\n"); "parameter file.\n");
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment