From 6e749eef22ec698cccf7f0bd808114015bb2939c Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <schaller@strw.leidenuniv.nl>
Date: Thu, 14 Nov 2019 11:25:40 +0100
Subject: [PATCH] Updated the documentation with the new meta runtime
parameter.
---
README | 8 ++++++++
README.md | 9 ++++++++-
doc/RTD/source/CommandLineOptions/index.rst | 7 +++++++
examples/EAGLE_ICs/EAGLE_12/run.sh | 6 +-----
examples/EAGLE_ICs/EAGLE_25/run.sh | 6 +-----
examples/EAGLE_ICs/EAGLE_50/run.sh | 6 +-----
6 files changed, 26 insertions(+), 16 deletions(-)
diff --git a/README b/README
index cd1be807a6..78f07a78dc 100644
--- a/README
+++ b/README
@@ -44,6 +44,14 @@ Parameters:
--sync Run with time-step synchronization
of particles hit by feedback events.
+ Simulation meta-options:
+
+ --eagle Run with all the options needed for the
+ EAGLE model. This is equivalent to --hydro
+ --limiter --sync --self-gravity --stars
+ --star-formation --cooling --feedback
+ --black-holes --fof.
+
Control options:
-a, --pin Pin runners using processor affinity.
diff --git a/README.md b/README.md
index c4fca31879..b4df1a355c 100644
--- a/README.md
+++ b/README.md
@@ -94,7 +94,14 @@ Parameters:
--limiter Run with time-step limiter.
--sync Run with time-step synchronization
of particles hit by feedback events.
-
+ Simulation meta-options:
+
+ --eagle Run with all the options needed for the
+ EAGLE model. This is equivalent to --hydro
+ --limiter --sync --self-gravity --stars
+ --star-formation --cooling --feedback
+ --black-holes --fof.
+
Control options:
-a, --pin Pin runners using processor affinity.
diff --git a/doc/RTD/source/CommandLineOptions/index.rst b/doc/RTD/source/CommandLineOptions/index.rst
index 353c8eafbf..f7cadd1f3a 100644
--- a/doc/RTD/source/CommandLineOptions/index.rst
+++ b/doc/RTD/source/CommandLineOptions/index.rst
@@ -40,6 +40,13 @@ can be found by typing ``./swift -h``:
--limiter Run with time-step limiter.
--sync Run with time-step synchronization
of particles hit by feedback events.
+ Simulation meta-options:
+
+ --eagle Run with all the options needed for the
+ EAGLE model. This is equivalent to --hydro
+ --limiter --sync --self-gravity --stars
+ --star-formation --cooling --feedback
+ --black-holes --fof.
Control options:
diff --git a/examples/EAGLE_ICs/EAGLE_12/run.sh b/examples/EAGLE_ICs/EAGLE_12/run.sh
index 2f375fa06d..e908b552de 100755
--- a/examples/EAGLE_ICs/EAGLE_12/run.sh
+++ b/examples/EAGLE_ICs/EAGLE_12/run.sh
@@ -30,11 +30,7 @@ fi
# The corresponding parameter file for this run
../../swift \
- --cosmology --hydro --self-gravity \
- --stars --star-formation \
- --cooling --feedback \
- --limiter --sync \
- --black-holes --fof \
+ --cosmology --eagle \
--threads=16 --pin \
eagle_12.yml
diff --git a/examples/EAGLE_ICs/EAGLE_25/run.sh b/examples/EAGLE_ICs/EAGLE_25/run.sh
index 03390a25d8..17dcb98069 100755
--- a/examples/EAGLE_ICs/EAGLE_25/run.sh
+++ b/examples/EAGLE_ICs/EAGLE_25/run.sh
@@ -30,10 +30,6 @@ fi
# The corresponding parameter file for this run
../../swift \
- --cosmology --hydro --self-gravity \
- --stars --star-formation \
- --cooling --feedback \
- --limiter --sync \
- --black-holes --fof \
+ --cosmology --eagle \
--threads=16 --pin \
eagle_25.yml
diff --git a/examples/EAGLE_ICs/EAGLE_50/run.sh b/examples/EAGLE_ICs/EAGLE_50/run.sh
index 9c7aa4471c..18e8f5cfce 100755
--- a/examples/EAGLE_ICs/EAGLE_50/run.sh
+++ b/examples/EAGLE_ICs/EAGLE_50/run.sh
@@ -30,10 +30,6 @@ fi
# The corresponding parameter file for this run
../../swift \
- --cosmology --hydro --self-gravity \
- --stars --star-formation \
- --cooling --feedback \
- --limiter --sync \
- --black-holes --fof \
+ --cosmology --eagle \
--threads=16 --pin \
eagle_50.yml
--
GitLab