Skip to content
Snippets Groups Projects
Commit 01242f63 authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Update all the READMEs to match the new command line options. Also indicate we... 

Update all the READMEs to match the new command line options. Also indicate we compile with AOCC and ICX
parent eaaa6b2c
No related branches found
No related tags found
2 merge requests!1715Update planetary strength after planetary plus's master rebase,!1693More threapool plotting tweaks
Hide whitespace changes
Inline Side-by-side
INSTALL.swift
+ 2
− 0
View file @ 01242f63
...@@ -37,6 +37,8 @@ SWIFT has been successfully built and tested with the following compilers: ...@@ -37,6 +37,8 @@ SWIFT has been successfully built and tested with the following compilers:
- GCC 4.8.x - GCC 4.8.x
- Intel ICC 15.0.x - Intel ICC 15.0.x
- clang 3.4.x - clang 3.4.x
- aocc 3.x
- icx (oneAPI) 2022.x
More recent versions and slightly older ones should also be able to More recent versions and slightly older ones should also be able to
build the software. build the software.
......
README
+ 14
− 12
View file @ 01242f63
...@@ -40,14 +40,16 @@ Parameters: ...@@ -40,14 +40,16 @@ Parameters:
-k, --sinks Run with sink particles. -k, --sinks Run with sink particles.
-u, --fof Run Friends-of-Friends algorithm to -u, --fof Run Friends-of-Friends algorithm to
perform black hole seeding. perform black hole seeding.
--lightcone Generate lightcone outputs.
-x, --velociraptor Run with structure finding. -x, --velociraptor Run with structure finding.
--line-of-sight Run with line-of-sight outputs. --line-of-sight Run with line-of-sight outputs.
--limiter Run with time-step limiter. --limiter Run with time-step limiter.
--sync Run with time-step synchronization --sync Run with time-step synchronization
of particles hit by feedback events. of particles hit by feedback events.
--csds Run with the Continuous Simulation Data Stream (CSDS). --csds Run with the Continuous Simulation Data
-R, --radiation Run with radiative transfer. Work in Stream (CSDS).
progress, currently has no effect. -R, --radiation Run with radiative transfer.
--power Run with power spectrum outputs.
Simulation meta-options: Simulation meta-options:
...@@ -68,7 +70,8 @@ Parameters: ...@@ -68,7 +70,8 @@ Parameters:
Control options: Control options:
-a, --pin Pin runners using processor affinity. -a, --pin Pin runners using processor affinity.
--interleave Interleave memory allocations over NUMA regions. --interleave Interleave memory allocations across
NUMA regions.
-d, --dry-run Dry run. Read the parameter file, allocates -d, --dry-run Dry run. Read the parameter file, allocates
memory but does not read the particles memory but does not read the particles
from ICs. Exits before the start of time from ICs. Exits before the start of time
...@@ -88,12 +91,12 @@ Parameters: ...@@ -88,12 +91,12 @@ Parameters:
read from the parameter file. Can be used read from the parameter file. Can be used
more than once {sec:par:value}. more than once {sec:par:value}.
-r, --restart Continue using restart files. -r, --restart Continue using restart files.
-t, --threads=<int> The number of task threads to use on each -t, --threads=<int> The number of task threads to use on each
MPI rank. Defaults to 1 if not specified. MPI rank. Defaults to 1 if not specified.
--pool-threads=<int> The number of threads to use on each MPI --pool-threads=<int> The number of threads to use on each MPI
rank for the threadpool operations. rank for the threadpool operations.
Defaults to the numbers of task threads Defaults to the numbers of task threads
if not specified. if not specified.
-T, --timers=<int> Print timers every time-step. -T, --timers=<int> Print timers every time-step.
-v, --verbose=<int> Run in verbose mode, in MPI mode 2 outputs -v, --verbose=<int> Run in verbose mode, in MPI mode 2 outputs
from all ranks. from all ranks.
...@@ -106,7 +109,6 @@ Parameters: ...@@ -106,7 +109,6 @@ Parameters:
--dump-tasks-threshold=<flt> Fraction of the total step's time spent --dump-tasks-threshold=<flt> Fraction of the total step's time spent
in a task to trigger a dump of the task plot in a task to trigger a dump of the task plot
on this step on this step
--power Run with power spectrum outputs.
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.
README.md
+ 12
− 11
View file @ 01242f63
...@@ -127,14 +127,16 @@ Parameters: ...@@ -127,14 +127,16 @@ Parameters:
-k, --sinks Run with sink particles. -k, --sinks Run with sink particles.
-u, --fof Run Friends-of-Friends algorithm to -u, --fof Run Friends-of-Friends algorithm to
perform black hole seeding. perform black hole seeding.
--lightcone Generate lightcone outputs.
-x, --velociraptor Run with structure finding. -x, --velociraptor Run with structure finding.
--line-of-sight Run with line-of-sight outputs. --line-of-sight Run with line-of-sight outputs.
--limiter Run with time-step limiter. --limiter Run with time-step limiter.
--sync Run with time-step synchronization --sync Run with time-step synchronization
of particles hit by feedback events. of particles hit by feedback events.
--csds Run with the Continuous Simulation Data Stream (CSDS). --csds Run with the Continuous Simulation Data
-R, --radiation Run with radiative transfer. Work in Stream (CSDS).
progress, currently has no effect. -R, --radiation Run with radiative transfer.
--power Run with power spectrum outputs.
Simulation meta-options: Simulation meta-options:
...@@ -155,7 +157,8 @@ Parameters: ...@@ -155,7 +157,8 @@ Parameters:
Control options: Control options:
-a, --pin Pin runners using processor affinity. -a, --pin Pin runners using processor affinity.
--interleave Interleave memory allocations over NUMA regions. --interleave Interleave memory allocations across
NUMA regions.
-d, --dry-run Dry run. Read the parameter file, allocates -d, --dry-run Dry run. Read the parameter file, allocates
memory but does not read the particles memory but does not read the particles
from ICs. Exits before the start of time from ICs. Exits before the start of time
...@@ -175,13 +178,12 @@ Parameters: ...@@ -175,13 +178,12 @@ Parameters:
read from the parameter file. Can be used read from the parameter file. Can be used
more than once {sec:par:value}. more than once {sec:par:value}.
-r, --restart Continue using restart files. -r, --restart Continue using restart files.
-t, --threads=<int> The number of task threads to use on each -t, --threads=<int> The number of task threads to use on each
MPI rank. Defaults to 1 if not specified. MPI rank. Defaults to 1 if not specified.
--pool-threads=<int> The number of threads to use on each MPI --pool-threads=<int> The number of threads to use on each MPI
rank for the threadpool operations. rank for the threadpool operations.
Defaults to the numbers of task threads Defaults to the numbers of task threads
if not specified. if not specified.
rank. Defaults to 1 if not specified.
-T, --timers=<int> Print timers every time-step. -T, --timers=<int> Print timers every time-step.
-v, --verbose=<int> Run in verbose mode, in MPI mode 2 outputs -v, --verbose=<int> Run in verbose mode, in MPI mode 2 outputs
from all ranks. from all ranks.
...@@ -194,7 +196,6 @@ Parameters: ...@@ -194,7 +196,6 @@ Parameters:
--dump-tasks-threshold=<flt> Fraction of the total step's time spent --dump-tasks-threshold=<flt> Fraction of the total step's time spent
in a task to trigger a dump of the task plot in a task to trigger a dump of the task plot
on this step on this step
--power Run with power spectrum outputs.
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.
``` ```
doc/RTD/source/CommandLineOptions/index.rst
+ 12
− 10
View file @ 01242f63
...@@ -37,14 +37,16 @@ can be found by typing ``./swift -h``: ...@@ -37,14 +37,16 @@ can be found by typing ``./swift -h``:
-k, --sinks Run with sink particles. -k, --sinks Run with sink particles.
-u, --fof Run Friends-of-Friends algorithm to -u, --fof Run Friends-of-Friends algorithm to
perform black hole seeding. perform black hole seeding.
--lightcone Generate lightcone outputs.
-x, --velociraptor Run with structure finding. -x, --velociraptor Run with structure finding.
--line-of-sight Run with line-of-sight outputs. --line-of-sight Run with line-of-sight outputs.
--limiter Run with time-step limiter. --limiter Run with time-step limiter.
--sync Run with time-step synchronization --sync Run with time-step synchronization
of particles hit by feedback events. of particles hit by feedback events.
--csds Run with the Continuous Simulation Data Stream (CSDS). --csds Run with the Continuous Simulation Data
-R, --radiation Run with radiative transfer. Work in Stream (CSDS).
progress, currently has no effect. -R, --radiation Run with radiative transfer.
--power Run with power spectrum outputs.
Simulation meta-options: Simulation meta-options:
...@@ -65,7 +67,8 @@ can be found by typing ``./swift -h``: ...@@ -65,7 +67,8 @@ can be found by typing ``./swift -h``:
Control options: Control options:
-a, --pin Pin runners using processor affinity. -a, --pin Pin runners using processor affinity.
--interleave Interleave memory allocations over NUMA regions. --interleave Interleave memory allocations across
NUMA regions.
-d, --dry-run Dry run. Read the parameter file, allocates -d, --dry-run Dry run. Read the parameter file, allocates
memory but does not read the particles memory but does not read the particles
from ICs. Exits before the start of time from ICs. Exits before the start of time
...@@ -85,11 +88,11 @@ can be found by typing ``./swift -h``: ...@@ -85,11 +88,11 @@ can be found by typing ``./swift -h``:
read from the parameter file. Can be used read from the parameter file. Can be used
more than once {sec:par:value}. more than once {sec:par:value}.
-r, --restart Continue using restart files. -r, --restart Continue using restart files.
-t, --threads=<int> The number of task threads to use on each -t, --threads=<int> The number of task threads to use on each
MPI rank. Defaults to 1 if not specified. MPI rank. Defaults to 1 if not specified.
--pool-threads=<int> The number of threads to use on each MPI --pool-threads=<int> The number of threads to use on each MPI
rank for the threadpool operations. rank for the threadpool operations.
Defaults to the numbers of task threads Defaults to the numbers of task threads
if not specified. if not specified.
-T, --timers=<int> Print timers every time-step. -T, --timers=<int> Print timers every time-step.
-v, --verbose=<int> Run in verbose mode, in MPI mode 2 outputs -v, --verbose=<int> Run in verbose mode, in MPI mode 2 outputs
...@@ -103,7 +106,6 @@ can be found by typing ``./swift -h``: ...@@ -103,7 +106,6 @@ can be found by typing ``./swift -h``:
--dump-tasks-threshold=<flt> Fraction of the total step's time spent --dump-tasks-threshold=<flt> Fraction of the total step's time spent
in a task to trigger a dump of the task plot in a task to trigger a dump of the task plot
on this step on this step
--power Run with power spectrum outputs.
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.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment