From 0144381c8ac72a21ce003d0dc9f1b6d9c42c3dd2 Mon Sep 17 00:00:00 2001 From: John Omotani Date: Wed, 20 Sep 2023 12:19:12 +0100 Subject: [PATCH] Documentation for restart functionality --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index b4fc35b775..14ca57bb81 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,28 @@ The full documentation is online at [https://mabarnes.github.io/moment_kinetics] ``` julia> run_moment_kinetics("input.toml") ``` +4b) To restart a simulation using `input.toml` from the last time point in the existing run directory, + ``` + $ julia -O3 --project run_moment_kinetics --restart input.toml + ``` + or to restart from a specific output file - either from the same run or (if the settings are compatible) a different one - here `runs/example/example.dfns.h5` + ``` + $ julia -O3 --project run_moment_kinetics input.toml runs/example/example.dfns.h5 + ``` + The output file must include distribution functions. When not using parallel I/O there will be multiple output files from different MPI ranks - any one of these can be passed. + * To do the same from the Julia REPL + ``` + $ julia -O3 --project + julia> run_moment_kinetics("input.toml", restart=true) + ``` + or + ``` + julia> run_moment_kinetics("input.toml", restart="runs/example/example.dfns.h5") + ``` + * When calling the `run_moment_kinetics()` function you can also choose a particular time index to restart from, e.g. + ``` + julia> run_moment_kinetics("input.toml", restart="runs/example/example.dfns.h5", restart_time_index=42) + ``` 5) To make plots and calculate frequencies/growth rates, run ``` $ julia --project run_post_processing.jl runs/