From 2b22e979a023d312ba4e89c0fac02c51b9a66364 Mon Sep 17 00:00:00 2001 From: monsterlag <64719697+monsterlag@users.noreply.github.com> Date: Thu, 22 Oct 2026 11:16:29 +0000 Subject: [PATCH] Document sandbox stability after case creation Warn in the quick start that cases continue to use the source sandbox and need it to stay unchanged until all associated cases are finished. Recommend a separate checkout for other versions and clarify that case-local settings and SourceMods can still be changed. Fixes #129. Testing: rebuilt the Sphinx HTML documentation before and after the change (both succeeded with the same two legacy-theme warnings). A rendered-HTML check fails on the original page and passes with the new warning under Create a case. git diff --check passes. --- doc/source/quickstart.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst index 98b156530b..597166e7fd 100644 --- a/doc/source/quickstart.rst +++ b/doc/source/quickstart.rst @@ -85,6 +85,17 @@ set to your cheyenne login name: ./create_newcase --case /glade/scratch/$USER/cases/b.e20.B1850.f19_g17.test --compset B1850 --res f19_g17 +.. warning:: + + Creating a case does not make an independent copy of the CESM source + code. The case continues to use the source code and scripts in + ``my_cesm_sandbox``. Do not change the code checked out in this sandbox + (for example, by switching CESM or component versions) until you are + finished with all cases created from it. Use a separate checkout for + experiments that need a different version. Case-local changes to XML + settings, namelists, and ``SourceMods`` can still be made as needed. + + Setting up the case run script ==============================