From b9c5013eef23777f0efc9d03cdeac3c19d2b35fd Mon Sep 17 00:00:00 2001 From: Malcolm Maas <60855169+malcolmmaas@users.noreply.github.com> Date: Mon, 16 Feb 2026 16:38:08 +0000 Subject: [PATCH] fix: use_restart behavior incorrect in docs --- docs/source/modules/introduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/modules/introduction.rst b/docs/source/modules/introduction.rst index 0455e671b..d89bf0887 100644 --- a/docs/source/modules/introduction.rst +++ b/docs/source/modules/introduction.rst @@ -82,7 +82,7 @@ Running the experiment exp.run(...) will make the model run for the amount of time specified in ``main_nml`` (usually 30 days). -The ``use_restart`` option can be set to ``False`` to start from scratch (isothermal atmosphere) or can point to a restart file (``use_restart = $GFDL_DATA/exp_name/run####/restarts/*``) to initialize the run from the output of a previous run. If unspecified, it will start from where the previous run left off or from an isothermal atmosphere in the absence of a previous run. +The ``use_restart`` option can be set to ``False`` to start from scratch (isothermal atmosphere) or ``True``, in which case ``restart_file`` must point to a restart file (``restart_file = $GFDL_DATA/exp_name/run####/restarts/*``) to initialize the run from the output of a previous run. If unspecified, it will start from where the previous run left off or from an isothermal atmosphere in the absence of a previous run. Output -------