diff --git a/.github/scripts/run-linkcheck.sh b/.github/scripts/run-linkcheck.sh old mode 100644 new mode 100755 index 6afc1ae8..ac76c4e4 --- a/.github/scripts/run-linkcheck.sh +++ b/.github/scripts/run-linkcheck.sh @@ -9,6 +9,11 @@ # Usage: run-linkcheck.sh BOOK_DIR FULL_LOG LINKCHECK_JSON # # Used by gh-page_builder.yml. +# +# Example: to run by hand outside of a github action on your local clone: +# ./.github/scripts/run-linkcheck.sh . full.log linkcheck.json +# # you then examine full.log and linkcheck.json if there were errors, but usually you don't care when run by hand +# set -u -o pipefail book_dir="$1" diff --git a/_config.yml b/_config.yml index 4e64b8fe..387d0423 100644 --- a/_config.yml +++ b/_config.yml @@ -34,9 +34,10 @@ sphinx: linkcheck_anchors: false # skip checking #anchors, which is often flaky linkcheck_report_timeouts_as_broken: False # - # Have the copy button appear on code blocks including the above parse-literal blocks + # Have the copy button appear on code blocks including the Jinja parse-literal blocks talked about below + # (Commented out as discussed below) # - copybutton_selector: "div.highlight pre, pre.literal-block" + #copybutton_selector: "div.highlight pre, pre.literal-block" # Force re-execution of notebooks on each build. # See https://jupyterbook.org/content/execute.html @@ -73,19 +74,17 @@ html: extra_navbar : "" parse: - # Jinja-2 Substitutions to make throughout all notebooks - # For example add: - # {{ CTSM_TUTORIAL_TAG }} - # For code blocks (make the code block a parsed-literal and do this: - # {{ '`' + CTSM_TUTORIAL_TAG + '`' }} - # To have it substitute the above from the substitutions.yml file below - # NOTE: this won't work for raw HTML blocks in markdown, so make the substitution outside of raw HTML. - myst_substitutions: - CTSM_TUTORIAL_TAG: "`ctsm5.4.067`" - CLM_TUTORIAL_DIR: "/glade/campaign/cgd/tss/tutorials/clm_2026" - CTSM_CUPID_TAG: "`CUPiD.n01_ctsm5.4.017`" - PROJECT_CODE: "UCGD0011" - TUTORIAL_QUE: "tutorial" + # Jinja-2 Substitutions that was a failed experiment + # Leaving here commented-out so we can figure out what the substitutions were next time: + # See PR: https://github.com/NCAR/CLM-Tutorial/pull/141 + # See Discussion: https://github.com/NCAR/CLM-Tutorial/discussions/142 + #myst_substitutions: + # CTSM_TUTORIAL_TAG: "`ctsm5.4.067`" + # CLM_TUTORIAL_DIR: "/glade/campaign/cgd/tss/tutorials/clm_2026" + # CTSM_CUPID_TAG: "`CUPiD.n01_ctsm5.4.017`" + # PROJECT_CODE: "UCGD0011" + # TUTORIAL_QUE: "tutorial" + #END OF SUBSTITUTIONS: launch_buttons: diff --git a/notebooks/basics/code/git_download_ctsm.ipynb b/notebooks/basics/code/git_download_ctsm.ipynb index 2d69d520..42a16462 100644 --- a/notebooks/basics/code/git_download_ctsm.ipynb +++ b/notebooks/basics/code/git_download_ctsm.ipynb @@ -24,9 +24,9 @@ "source": [ "
\n", "\n", - "**We will use the CLM6 tutorial tag: {{ CTSM_TUTORIAL_TAG }}**\n", + "**We will use the CLM6 tutorial tag: `ctsm5.4.067`**\n", "\n", - "**Note: **At the time of the tutorial, the final CLM6 release has not yet been completed. Therefore, we will use a preliminary tag ({{ CTSM_TUTORIAL_TAG }}) that contains the CLM6 code base and configuration needed for the exercises. The exact tag used in the tutorial may differ from the final CLM6 release.\n", + "**Note: **At the time of the tutorial, the final CLM6 release has not yet been completed. Therefore, we will use a preliminary tag (`ctsm5.4.067`) that contains the CLM6 code base and configuration needed for the exercises. The exact tag used in the tutorial may differ from the final CLM6 release.\n", "\n", "
" ] @@ -101,10 +101,10 @@ " \n", "- **Download the CLM code to your code workspace directory as `my_clm_code`:**\n", "\n", - "```{parsed-literal}\n", + "```bash\n", "git clone https://github.com/ESCOMP/CTSM.git my_clm_code\n", "cd my_clm_code\n", - "git checkout {{ '`' + CTSM_TUTORIAL_TAG + '`' }}\n", + "git checkout ctsm5.4.067\n", "```\n", "The directory name `my_clm_code` is only an example. You may choose any directory name you prefer. Outside of this tutorial, many users choose names that identify the CLM version they are working with (for example, `ctsm6.0`, `ctsm5.5` or `clm6.0_Tutorial2026`).\n", "\n", @@ -118,7 +118,7 @@ "\n", "which should return:\n", "\n", - " {{ CTSM_TUTORIAL_TAG }}\n", + " `ctsm5.4.067`\n", "" ] }, diff --git a/notebooks/basics/exercises/change_compsets.ipynb b/notebooks/basics/exercises/change_compsets.ipynb index 2f40930d..19dcb80a 100644 --- a/notebooks/basics/exercises/change_compsets.ipynb +++ b/notebooks/basics/exercises/change_compsets.ipynb @@ -165,8 +165,8 @@ "```\n", "\n", "Change the queue to the 'tutorial' queue:\n", - "``` {parsed-literal}\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }} --force\n", + "```bash\n", + "./xmlchange JOB_QUEUE=tutorial --force\n", "```\n", "\n", "Extend the length of the run to 1 month:\n", diff --git a/notebooks/basics/exercises/first_I1850.ipynb b/notebooks/basics/exercises/first_I1850.ipynb index 9bf79ba6..22e96d69 100644 --- a/notebooks/basics/exercises/first_I1850.ipynb +++ b/notebooks/basics/exercises/first_I1850.ipynb @@ -61,8 +61,8 @@ "```\n", "\n", "Change the queue to the 'tutorial' queue:\n", - "``` {parsed-literal}\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }} --force\n", + "```bash\n", + "./xmlchange JOB_QUEUE=tutorial --force\n", "```\n", "\n", "Make sure you use the correct information for the CASE, RES, and COMPSET inputs.\n", @@ -113,8 +113,8 @@ "```\n", "\n", "Change the queue to the 'tutorial' queue:\n", - "``` {parsed-literal}\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }} --force\n", + "```bash\n", + "./xmlchange JOB_QUEUE=tutorial --force\n", "```\n", "\n", "Do not make any other changes since we are running an out-of-the-box simulation.\n", diff --git a/notebooks/diagnostics/cupid/clm_cupid_ldf_ilamb.ipynb b/notebooks/diagnostics/cupid/clm_cupid_ldf_ilamb.ipynb index 0930bac3..9088a118 100644 --- a/notebooks/diagnostics/cupid/clm_cupid_ldf_ilamb.ipynb +++ b/notebooks/diagnostics/cupid/clm_cupid_ldf_ilamb.ipynb @@ -66,7 +66,7 @@ "We hope to eventually release a version of the CLM that includes CUPiD. For now we have you clone a branch that tests this idea in a recent version of the CLM.\n", "\n", "The following lines:\n", - "- clone the branch into a new directory {{ CTSM_CUPID_TAG }}\n", + "- clone the branch into a new directory `CUPiD.n01_ctsm5.4.017`\n", "- enter the directory just created\n", "- update submodules, one of which is CUPiD\n", "- enter the directory tools/CUPiD\n", @@ -79,11 +79,12 @@ "id": "943f6b99-58d0-4cb2-8abe-2255e0b1cebb", "metadata": {}, "source": [ - "```{parsed-literal}\n", - "git clone -b branch_tags/{{ '`' + CTSM_CUPID_TAG + '`' }} https\\://github.com/ESCOMP/ctsm.git {{ '`' + CTSM_CUPID_TAG + '`' }}\n", - "cd {{ '`' + CTSM_CUPID_TAG + '`' }}\n", + "```bash\n", + "git clone -b branch_tags/CUPiD.n01_ctsm5.4.017 https://github.com/ESCOMP/ctsm.git CUPiD.n01_ctsm5.4.017\n", + "cd CUPiD.n01_ctsm5.4.017\n", "./bin/git-fleximod update\n", - "cd tools/CUPiD" + "cd tools/CUPiD\n", + "```" ] }, { diff --git a/notebooks/diagnostics/diagnostics_intro.ipynb b/notebooks/diagnostics/diagnostics_intro.ipynb index a155d756..3fdfe92c 100644 --- a/notebooks/diagnostics/diagnostics_intro.ipynb +++ b/notebooks/diagnostics/diagnostics_intro.ipynb @@ -110,7 +110,7 @@ "|---|---|\n", "| **Resource Selection** | Casper PBS Batch |\n", "| **Queue or Reservation** | casper |\n", - "| **Project Account** | {{ PROJECT_CODE }} |\n", + "| **Project Account** | UCGD0011 |\n", "| **Wall Time in Hours** | 3 |" ] }, diff --git a/notebooks/diagnostics/ldf/ldf_basics.ipynb b/notebooks/diagnostics/ldf/ldf_basics.ipynb index 8262e1ba..41caba78 100644 --- a/notebooks/diagnostics/ldf/ldf_basics.ipynb +++ b/notebooks/diagnostics/ldf/ldf_basics.ipynb @@ -100,8 +100,9 @@ "id": "da9828ff-197c-4309-b038-cc0a53ae4b4f", "metadata": {}, "source": [ - "``` {parsed-literal}\n", - "qsub -I -X -l select=1:ncpus=8:mem=64GB -A {{ PROJECT_CODE }} -q casper@casper-pbs -l walltime=02:00:00\n" + "```bash\n", + "qsub -I -X -l select=1:ncpus=8:mem=64GB -A UCGD0011 -q casper@casper-pbs -l walltime=02:00:00\n", + "```\n" ] }, { diff --git a/notebooks/modifications/namelist/exercises/exercise_clm_history_frequency.ipynb b/notebooks/modifications/namelist/exercises/exercise_clm_history_frequency.ipynb index 5b03a4e0..d9cc4861 100644 --- a/notebooks/modifications/namelist/exercises/exercise_clm_history_frequency.ipynb +++ b/notebooks/modifications/namelist/exercises/exercise_clm_history_frequency.ipynb @@ -111,12 +111,12 @@ "**Change the wallclock time, job queue, and account number**\n", "\n", "Change the wallclock time. If needed, change `job queue` and `account number`.
\n", - "For instance, to run in the queue `tutorial` and the project number {{ PROJECT_CODE }} (You should use the project number given for this tutorial), use the command:\n", + "For instance, to run in the queue `tutorial` and the project number UCGD0011 (You should use the project number given for this tutorial), use the command:\n", "\n", - "``` {parsed-literal}\n", + "```bash\n", "./xmlchange JOB_WALLCLOCK_TIME=01:00:00\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }}\n", - "./xmlchange PROJECT={{ '`' + PROJECT_CODE + '`' }} --force\n", + "./xmlchange JOB_QUEUE=tutorial\n", + "./xmlchange PROJECT=UCGD0011 --force\n", "```\n", "\n", "**Build and submit**\n", diff --git a/notebooks/modifications/namelist/exercises/exercise_clm_history_vars.ipynb b/notebooks/modifications/namelist/exercises/exercise_clm_history_vars.ipynb index ab39bd0b..74e039ab 100644 --- a/notebooks/modifications/namelist/exercises/exercise_clm_history_vars.ipynb +++ b/notebooks/modifications/namelist/exercises/exercise_clm_history_vars.ipynb @@ -83,7 +83,7 @@ "\n", "Create a new case called `i2000_bgc_hist_update`:\n", "\n", - "``` {parsed-literal}\n", + "```bash\n", "cd /glade/u/home/$USER/code/my_clm_code/cime/scripts/\n", "\n", "./create_newcase --case ~/cases/i2000_bgc_hist_update \\\n", @@ -122,12 +122,12 @@ "\n", "**Change the job queue, wallclock time, and account number**\n", "\n", - "Update the wallclock time. If needed, change the job queue and project number. For example, to run in the {{ '`' + TUTORIAL_QUE + '`' }} queue using project {{ '`' + PROJECT_CODE + '`' }}, use:\n", + "Update the wallclock time. If needed, change the job queue and project number. For example, to run in the `tutorial` queue using project `UCGD0011`, use:\n", "\n", - "``` {parsed-literal}\n", + "```bash\n", "./xmlchange JOB_WALLCLOCK_TIME=01:00:00\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }}\n", - "./xmlchange PROJECT={{ '`' + PROJECT_CODE + '`' }} --force\n", + "./xmlchange JOB_QUEUE=tutorial\n", + "./xmlchange PROJECT=UCGD0011 --force\n", "```\n", "\n", "Use the project number provided for the tutorial.\n", diff --git a/notebooks/modifications/namelist/exercises/exercise_fates_complexity.ipynb b/notebooks/modifications/namelist/exercises/exercise_fates_complexity.ipynb index f892caf8..b67442e3 100644 --- a/notebooks/modifications/namelist/exercises/exercise_fates_complexity.ipynb +++ b/notebooks/modifications/namelist/exercises/exercise_fates_complexity.ipynb @@ -138,10 +138,10 @@ "\n", "If needed:\n", "\n", - "``` {parsed-literal}\n", + "```bash\n", "./xmlchange JOB_WALLCLOCK_TIME=01:00:00\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }}\n", - "./xmlchange PROJECT={{ '`' + PROJECT_CODE + '`' }} --force\n", + "./xmlchange JOB_QUEUE=tutorial\n", + "./xmlchange PROJECT=UCGD0011 --force\n", "```\n", "\n", "Use the project number provided for the tutorial.\n", diff --git a/notebooks/modifications/xml/exercises/xml_datm_exercise.ipynb b/notebooks/modifications/xml/exercises/xml_datm_exercise.ipynb index 31299934..85beb271 100644 --- a/notebooks/modifications/xml/exercises/xml_datm_exercise.ipynb +++ b/notebooks/modifications/xml/exercises/xml_datm_exercise.ipynb @@ -82,7 +82,7 @@ " \n", "2. In your case directory, change the runtime variables:\n", " \n", - "``` {parsed-literal}\n", + "```bash\n", "cd /glade/u/home/$USER/cases/i2000_forcing_years\n", "./xmlchange DATM_YR_START=2005\n", "./xmlchange DATM_YR_END=2009\n", @@ -90,8 +90,8 @@ "./xmlchange STOP_N=1\n", "./xmlchange STOP_OPTION='nyears'\n", "./xmlchange JOB_WALLCLOCK_TIME=1:00:00\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }} --force\n", - "``` \n", + "./xmlchange JOB_QUEUE=tutorial --force\n", + "```\n", "\n", "3. Set up the case:\n", " \n", diff --git a/notebooks/modifications/xml/exercises/xml_length_exercise.ipynb b/notebooks/modifications/xml/exercises/xml_length_exercise.ipynb index 5c539687..a0ca5b3f 100644 --- a/notebooks/modifications/xml/exercises/xml_length_exercise.ipynb +++ b/notebooks/modifications/xml/exercises/xml_length_exercise.ipynb @@ -75,11 +75,11 @@ " \n", "In your case directory, change debugging levels and set runtime variables:\n", "\n", - "``` {parsed-literal}\n", + "```bash\n", "cd /glade/u/home/$USER/cases/i1850_sp.length\n", "./xmlchange PIO_DEBUG_LEVEL=1,STOP_N=6,STOP_OPTION=nmonths\n", "./xmlchange --subgroup case.run JOB_WALLCLOCK_TIME=2:00:00\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }} --force\n", + "./xmlchange JOB_QUEUE=tutorial --force\n", "```\n", "
\n", " \n", diff --git a/notebooks/modifications/xml/exercises/xml_runtype_exercise.ipynb b/notebooks/modifications/xml/exercises/xml_runtype_exercise.ipynb index a944e555..bf6b6931 100644 --- a/notebooks/modifications/xml/exercises/xml_runtype_exercise.ipynb +++ b/notebooks/modifications/xml/exercises/xml_runtype_exercise.ipynb @@ -86,13 +86,13 @@ "\n", "3. Set run time variables: \n", " \n", - "``` {parsed-literal}\n", + "```bash\n", "./xmlchange STOP_OPTION=nmonths\n", "./xmlchange STOP_N=1\n", "./xmlchange RESUBMIT=1\n", "./xmlchange JOB_WALLCLOCK_TIME=02:00:00\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }} --force\n", - "``` \n", + "./xmlchange JOB_QUEUE=tutorial --force\n", + "```\n", "\n", "4. Set up the case:\n", " \n", diff --git a/notebooks/prereqs/prereqs_overview.ipynb b/notebooks/prereqs/prereqs_overview.ipynb index cc557706..22b057c1 100644 --- a/notebooks/prereqs/prereqs_overview.ipynb +++ b/notebooks/prereqs/prereqs_overview.ipynb @@ -160,7 +160,7 @@ "\n", "![Entering options for server on JupyterHub](../../images/resources/OnDemand_launch_Jupyter_batch.png)\n", "*

Figure: Entering options for server on JupyterHub.

*\n", - "Select the “Casper PBS Batch” option in the drop-down menu. Afterward, you will need to make other choices to select the right resources: 3 hours wall time to ensure your server is active for the entire hands-on activity session and Project Account {{ '`' + PROJECT_CODE + '`' }}. Now launch the server.\n", + "Select the “Casper PBS Batch” option in the drop-down menu. Afterward, you will need to make other choices to select the right resources: 3 hours wall time to ensure your server is active for the entire hands-on activity session and Project Account `UCGD0011`. Now launch the server.\n", "\n", "**Step 5. Connect to Jupyter**\n", "\n", diff --git a/notebooks/resources/ncar_hpc.ipynb b/notebooks/resources/ncar_hpc.ipynb index fa06fd3f..f92f676c 100644 --- a/notebooks/resources/ncar_hpc.ipynb +++ b/notebooks/resources/ncar_hpc.ipynb @@ -141,7 +141,7 @@ "\n", "![Entering options for server on JupyterHub](../../images/resources/OnDemand_launch_Jupyter_batch.png)\n", "*

Figure: Entering options for server on JupyterHub.

*\n", - "Select the “Casper PBS Batch” option in the drop down menu. Afterward, you will need to make other choices to select the right resources: 3 hours wall time to ensure your server is active for the entire hands-on activity session and Project Account {{ '`' + PROJECT_CODE + '`' }}. Now launch the server.\n", + "Select the “Casper PBS Batch” option in the drop down menu. Afterward, you will need to make other choices to select the right resources: 3 hours wall time to ensure your server is active for the entire hands-on activity session and Project Account `UCGD0011`. Now launch the server.\n", "\n", "**Step 5. Connect to Jupyter**\n", "\n", diff --git a/notebooks/resources/ncar_hpc_login.ipynb b/notebooks/resources/ncar_hpc_login.ipynb index ba7555cb..7948a7a1 100644 --- a/notebooks/resources/ncar_hpc_login.ipynb +++ b/notebooks/resources/ncar_hpc_login.ipynb @@ -141,7 +141,7 @@ "\n", "![Entering options for server on JupyterHub](../../images/resources/OnDemand_launch_Jupyter_batch.png)\n", "*

Figure: Entering options for server on JupyterHub.

*\n", - "Select the “Casper PBS Batch” option in the drop down menu. Afterward, you will need to make other choices to select the right resources: 3 hours wall time to ensure your server is active for the entire hands-on activity session and Project Account {{ '`' + PROJECT_CODE + '`' }}. Now launch the server.\n", + "Select the “Casper PBS Batch” option in the drop down menu. Afterward, you will need to make other choices to select the right resources: 3 hours wall time to ensure your server is active for the entire hands-on activity session and Project Account `UCGD0011`. Now launch the server.\n", "\n", "**Step 5. Connect to Jupyter**\n", "\n", diff --git a/notebooks/resources/profile.ipynb b/notebooks/resources/profile.ipynb index ce6fa71c..adae2827 100644 --- a/notebooks/resources/profile.ipynb +++ b/notebooks/resources/profile.ipynb @@ -17,7 +17,7 @@ "\n", "
\n", "\n", - "You should have access to project account **{{ PROJECT_CODE }}** and use this for your simulations.\n", + "You should have access to project account **UCGD0011** and use this for your simulations.\n", "
\n", "\n" ] @@ -50,13 +50,11 @@ "source": [ "In theory, you _should_ be able to automatically use this account and the reservation queues if you correctly set up your NCAR HPC environment using your `.profile` or `.tcshrc` files, as described below. If you need to change the values for a run, you can change the account and reservation queue in your case directory using the following command:\n", "\n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "./xmlchange --force JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }}\n", - "./xmlchange PROJECT={{ '`' + PROJECT_CODE + '`' }}\n", + "```bash\n", + "./xmlchange --force JOB_QUEUE=tutorial\n", + "./xmlchange PROJECT=UCGD0011\n", "```\n", "\n", - ":::\n", "\n", "You should not have to set the `PROJECT` more than once during the tutorial if your profile is set up, as described below, but we include it for your reference in case you are having trouble." ] @@ -175,8 +173,8 @@ "\n", "Copy over the `.profile` file into your home directory: \n", " \n", - "``` {parsed-literal}\n", - "cp {{ '`' + CLM_TUTORIAL_DIR + '`' }}/tutorial_env//profile ~/.profile\n", + "```bash\n", + "cp /glade/campaign/cgd/tss/tutorials/clm_2026/tutorial_env//profile ~/.profile\n", "```\n", "
\n", "\n", @@ -224,7 +222,7 @@ "id": "42432d90-eaef-4205-b4fe-39cf3c7b5881", "metadata": {}, "source": [ - "**NOTE:** You should already have a `.tcshrc` file in your home directory. If you do not wish to overwrite the existing `.tcshrc` file, please save this file to a new name OR copy the contents of the {{ CLM_TUTORIAL_DIR }}/tutorial_env//tcshrc file to your `.tcshrc` file using a text editor." + "**NOTE:** You should already have a `.tcshrc` file in your home directory. If you do not wish to overwrite the existing `.tcshrc` file, please save this file to a new name OR copy the contents of the /glade/campaign/cgd/tss/tutorials/clm_2026/tutorial_env//tcshrc file to your `.tcshrc` file using a text editor." ] }, { @@ -247,8 +245,8 @@ "
\n", "\n", "Copy over the `.tcshrc` file to your home directory:\n", - "``` {parsed-literal}\n", - "cp {{ '`' + CLM_TUTORIAL_DIR + '`' }}/tutorial_env//tcshrc ~/.tcshrc\n", + "```bash\n", + "cp /glade/campaign/cgd/tss/tutorials/clm_2026/tutorial_env//tcshrc ~/.tcshrc\n", "```\n", " \n", "
\n", @@ -319,9 +317,9 @@ "\n", "Add to your .profile: \n", "\n", - "``` {parsed-literal}\n", - "export PROJECT={{ '`' + PROJECT_CODE + '`' }} #<- This should never change over the course of the tutorial\n", - "export TUTORIAL_QUEUE={{ '`' + TUTORIAL_QUE + '`' }}\n", + "```bash\n", + "export PROJECT=UCGD0011 #<- This should never change over the course of the tutorial\n", + "export TUTORIAL_QUEUE=tutorial\n", "```\n", "\n", "Source the file:
\n", @@ -336,9 +334,9 @@ "
\n", "\n", "Add to your .tcshrc: \n", - "``` {parsed-literal}\n", - "setenv PROJECT {{ '`' + PROJECT_CODE + '`' }} #<-This should never change over the course of the tutorial\n", - "setenv TUTORIAL_QUEUE {{ '`' + TUTORIAL_QUE + '`' }}\n", + "```tcsh\n", + "setenv PROJECT UCGD0011 #<-This should never change over the course of the tutorial\n", + "setenv TUTORIAL_QUEUE tutorial\n", "```\n", " \n", "Source the file:
\n", diff --git a/notebooks/resources/tutorial_one_time_setup.ipynb b/notebooks/resources/tutorial_one_time_setup.ipynb index 088e7cd4..764c4fe5 100644 --- a/notebooks/resources/tutorial_one_time_setup.ipynb +++ b/notebooks/resources/tutorial_one_time_setup.ipynb @@ -122,12 +122,10 @@ "\n", "Copy over the `.profile` file into your home directory: \n", " \n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "cp {{ '`' + CLM_TUTORIAL_DIR + '`' }}/tutorial_env/profile ~/.profile\n", + "```bash\n", + "cp /glade/campaign/cgd/tss/tutorials/clm_2026/tutorial_env/profile ~/.profile\n", "```\n", "\n", - ":::\n", "\n", "
\n", "\n", @@ -161,7 +159,7 @@ "id": "42432d90-eaef-4205-b4fe-39cf3c7b5881", "metadata": {}, "source": [ - "**NOTE:** You should already have a `.tcshrc` file in your home directory. If you do not wish to overwrite the existing `.tcshrc` file, please save this file to a new name OR copy the contents of the {{ CLM_TUTORIAL_DIR }}/tutorial_env/tcshrc file to your `.tcshrc` file using a text editor." + "**NOTE:** You should already have a `.tcshrc` file in your home directory. If you do not wish to overwrite the existing `.tcshrc` file, please save this file to a new name OR copy the contents of the /glade/campaign/cgd/tss/tutorials/clm_2026/tutorial_env/tcshrc file to your `.tcshrc` file using a text editor." ] }, { @@ -185,12 +183,10 @@ "\n", "Copy over the `.tcshrc` file to your home directory:\n", "\n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "cp {{ '`' + CLM_TUTORIAL_DIR + '`' }}/tutorial_env/tcshrc ~/.tcshrc\n", + "```bash\n", + "cp /glade/campaign/cgd/tss/tutorials/clm_2026/tutorial_env/tcshrc ~/.tcshrc\n", "```\n", "\n", - ":::\n", " \n", "
\n", "\n", @@ -249,12 +245,10 @@ "\n", "Add to your .profile: \n", "\n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "export PROJECT={{ '`' + PROJECT_CODE + '`' }} #<- This should never change over the course of the tutorial\n", + "```bash\n", + "export PROJECT=UCGD0011 #<- This should never change over the course of the tutorial\n", "```\n", "\n", - ":::\n", "\n", "Source the file:
\n", "\n", @@ -269,12 +263,10 @@ "\n", "Add to your .tcshrc: \n", "\n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "setenv PROJECT {{ '`' + PROJECT_CODE + '`' }} #<-This should never change over the course of the tutorial\n", + "```tcsh\n", + "setenv PROJECT UCGD0011 #<-This should never change over the course of the tutorial\n", "```\n", "\n", - ":::\n", " \n", "Source the file:
\n", "\n", diff --git a/notebooks/resources/tutorial_queue_account.ipynb b/notebooks/resources/tutorial_queue_account.ipynb index 9eb04f2e..3da951ae 100644 --- a/notebooks/resources/tutorial_queue_account.ipynb +++ b/notebooks/resources/tutorial_queue_account.ipynb @@ -17,18 +17,16 @@ "\n", "
\n", "\n", - "You should have access to project account {{ PROJECT_CODE }} and use this for your simulations.\n", + "You should have access to project account UCGD0011 and use this for your simulations.\n", "\n", "
\n", "\n", "You can change the account in your case directory using the following command:\n", "\n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "./xmlchange PROJECT={{ '`' + PROJECT_CODE + '`' }}\n", + "```bash\n", + "./xmlchange PROJECT=UCGD0011\n", "```\n", - "\n", - ":::" + "\n" ] }, { @@ -42,7 +40,7 @@ "\n", "**Tutorial Reservation Queues**\n", " \n", - "- We have a special queue called **{{ TUTORIAL_QUE }}** during the lab sessions to ensure you get through the derecho queues quickly and get your jobs run. This queue is only active during the day. \n", + "- We have a special queue called **tutorial** during the lab sessions to ensure you get through the derecho queues quickly and get your jobs run. This queue is only active during the day. \n", "\n", "- Outside the lab sessions, you should use the queue **main** to run CLM.\n", " \n", @@ -52,12 +50,10 @@ "\n", "During the lab sessions:\n", "\n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }} --force\n", + "```bash\n", + "./xmlchange JOB_QUEUE=tutorial --force\n", "```\n", "\n", - ":::\n", "\n", "Outside the lab sessions:\n", "\n", @@ -79,16 +75,14 @@ "id": "6ddf7177-0dd6-4ce3-be1e-ee70e5be9419", "metadata": {}, "source": [ - "By default, we compile CTSM on a shared queue called `develop`. However, as we want to avoid long wait time during the labs, we will compile in the special reservation queue {{ TUTORIAL_QUE }}.\n", + "By default, we compile CTSM on a shared queue called `develop`. However, as we want to avoid long wait time during the labs, we will compile in the special reservation queue tutorial.\n", "\n", "During the lab sessions, use\n", "\n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "qcmd -q {{ '`' + TUTORIAL_QUE + '`' }} -- ./case.build \n", + "```bash\n", + "qcmd -q tutorial -- ./case.build \n", "```\n", "\n", - ":::\n", "\n", "\n", "Outside the lab sessions, use\n", diff --git a/notebooks/resources/tutorial_specific.ipynb b/notebooks/resources/tutorial_specific.ipynb index dc529410..b2d99975 100644 --- a/notebooks/resources/tutorial_specific.ipynb +++ b/notebooks/resources/tutorial_specific.ipynb @@ -16,16 +16,14 @@ "### Tutorial Project Account\n", "\n", "
\n", - "You should have access to project account **{{ PROJECT_CODE }}** and use this for your simulations.\n", + "You should have access to project account **UCGD0011** and use this for your simulations.\n", "
\n", "\n", "You can change the account in your case directory using the following command:\n", "\n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "./xmlchange PROJECT={{ '`' + PROJECT_CODE + '`' }}\n", - "```""\n", - ":::" + "```bash\n", + "./xmlchange PROJECT=UCGD0011\n", + "```\n" ] }, { @@ -39,7 +37,7 @@ "\n", "Schedule for Tutorial Reservation Queues\n", " \n", - "- We have a special queue **{{ TUTORIAL_QUE }}** during the lab sessions to ensure you get through the derecho queues quickly and get your jobs run. This queue is only active during our lab sessions. \n", + "- We have a special queue **tutorial** during the lab sessions to ensure you get through the derecho queues quickly and get your jobs run. This queue is only active during our lab sessions. \n", "\n", "- Outside the lab sessions, you should use the queue cpu\n", " \n", @@ -50,12 +48,10 @@ "\n", "During the lab sessions:\n", "\n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }} --force\n", + "```bash\n", + "./xmlchange JOB_QUEUE=tutorial --force\n", "```\n", "\n", - ":::\n", "\n", "Outside the lab sessions:\n", "``` bash\n", @@ -195,12 +191,10 @@ "\n", "Copy over the `.profile` file into your home directory: \n", " \n", - ":::{container} highlight\n", - "``` {parsed-literal}\n", - "cp {{ '`' + CLM_TUTORIAL_DIR + '`' }}/tutorial_env/profile ~/.profile\n", + "```bash\n", + "cp /glade/campaign/cgd/tss/tutorials/clm_2026/tutorial_env/profile ~/.profile\n", "```\n", "\n", - ":::\n", "\n", "
\n", "\n", @@ -234,7 +228,7 @@ "id": "42432d90-eaef-4205-b4fe-39cf3c7b5881", "metadata": {}, "source": [ - "**NOTE:** You should already have a `.tcshrc` file in your home directory. If you do not wish to overwrite the existing `.tcshrc` file, please save this file to a new name OR copy the contents of the {{ CLM_TUTORIAL_DIR }}/tutorial_env/tcshrc` file to your `.tcshrc` file using a text editor." + "**NOTE:** You should already have a `.tcshrc` file in your home directory. If you do not wish to overwrite the existing `.tcshrc` file, please save this file to a new name OR copy the contents of the /glade/campaign/cgd/tss/tutorials/clm_2026/tutorial_env/tcshrc` file to your `.tcshrc` file using a text editor." ] }, { @@ -257,8 +251,8 @@ "
\n", "\n", "Copy over the `.tcshrc` file to your home directory:\n", - "``` {parsed-literal}\n", - "cp {{ '`' + CLM_TUTORIAL_DIR + '`' }}/tutorial_env/tcshrc ~/.tcshrc\n", + "```bash\n", + "cp /glade/campaign/cgd/tss/tutorials/clm_2026/tutorial_env/tcshrc ~/.tcshrc\n", "```\n", " \n", "
\n", @@ -315,9 +309,9 @@ "\n", "Add to your .profile: \n", "\n", - "``` {parsed-literal}\n", - "export PROJECT={{ '`' + PROJECT_CODE + '`' }} #<- This should never change over the course of the tutorial\n", - "export TUTORIAL_QUEUE={{ '`' + TUTORIAL_QUE + '`' }} #<- Special queue for the tutorial\n", + "```bash\n", + "export PROJECT=UCGD0011 #<- This should never change over the course of the tutorial\n", + "export TUTORIAL_QUEUE=tutorial #<- Special queue for the tutorial\n", "```\n", "\n", "Source the file:
\n", @@ -332,9 +326,9 @@ "
\n", "\n", "Add to your .tcshrc: \n", - "``` {parsed-literal}\n", - "setenv PROJECT {{ '`' + PROJECT_CODE + '`' }} #<-This should never change over the course of the tutorial\n", - "setenv TUTORIAL_QUEUE {{ '`' + TUTORIAL_QUE + '`' }} #<- Special queue for the tutorial\n", + "```tcsh\n", + "setenv PROJECT UCGD0011 #<-This should never change over the course of the tutorial\n", + "setenv TUTORIAL_QUEUE tutorial #<- Special queue for the tutorial\n", "```\n", " \n", "Source the file:
\n", @@ -377,4 +371,4 @@ }, "nbformat": 4, "nbformat_minor": 5 -} +} \ No newline at end of file diff --git a/notebooks/sensitivity/03_submit_ensemble.ipynb b/notebooks/sensitivity/03_submit_ensemble.ipynb index 1f642a40..ee7dc348 100644 --- a/notebooks/sensitivity/03_submit_ensemble.ipynb +++ b/notebooks/sensitivity/03_submit_ensemble.ipynb @@ -262,7 +262,7 @@ "source": [ "Each member's case will be named `___`, so the first member's case will be `BONA.FATESsp_oat_fates_oat_0000_run`.\n", "\n", - "The cell below writes this file for us. Be sure to replace `XXXXXXXX` with your project code ({{ PROJECT_CODE }} for this tutorial)." + "The cell below writes this file for us. Be sure to replace `XXXXXXXX` with your project code (UCGD0011 for this tutorial)." ] }, { @@ -449,8 +449,8 @@ "
\n", "\n", "**Note:** The queue here is for the _setup job_, not the actual CLM-FATES case. To modify the job queues for your actual CLM jobs, use xmlchange commands inside the stage script.\n", - "``` {parsed-literal}\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }}\n", + "```bash\n", + "./xmlchange JOB_QUEUE=tutorial\n", "```\n", "
" ] diff --git a/notebooks/singlepoint/exercises/runtower_NEON.ipynb b/notebooks/singlepoint/exercises/runtower_NEON.ipynb index 954e3812..66b76471 100644 --- a/notebooks/singlepoint/exercises/runtower_NEON.ipynb +++ b/notebooks/singlepoint/exercises/runtower_NEON.ipynb @@ -108,8 +108,8 @@ "\n", "Create a new case ABBY.transient with the command:\n", "\n", - "```{parsed-literal}\n", - "./run_tower --neon-sites ABBY --output-root ~/cases/. --xmlchange PROJECT={{ '`' + PROJECT_CODE + '`' }}\n", + "```bash\n", + "./run_tower --neon-sites ABBY --output-root ~/cases/. --xmlchange PROJECT=UCGD0011\n", "```\n", "\n", "During this time `run_tower` will complete steps 1-4 listed above.\n", diff --git a/notebooks/singlepoint/exercises/runtower_PLUMBER2.ipynb b/notebooks/singlepoint/exercises/runtower_PLUMBER2.ipynb index 6b1a7d05..1b9da516 100644 --- a/notebooks/singlepoint/exercises/runtower_PLUMBER2.ipynb +++ b/notebooks/singlepoint/exercises/runtower_PLUMBER2.ipynb @@ -149,11 +149,11 @@ "cd /glade/u/home/$USER/code/my_clm_code/tools/site_and_regional\n", "```\n", "\n", - "```{parsed-literal}\n", - "./run_tower --plumber-sites BR-Sa3 \\\\\n", - "--output-root /glade/u/home/$USER/cases \\\\\n", - "--experiment test0 \\\\\n", - "--xmlchange PROJECT={{ '`' + PROJECT_CODE + '`' }}\n", + "```bash\n", + "./run_tower --plumber-sites BR-Sa3 \\\n", + "--output-root /glade/u/home/$USER/cases \\\n", + "--experiment test0 \\\n", + "--xmlchange PROJECT=UCGD0011\n", "```\n", "\n", "Move to your case directory: BR-Sa3.test0.ad:\n", diff --git a/notebooks/troubleshooting/exercises/troubleshooting_cam.ipynb b/notebooks/troubleshooting/exercises/troubleshooting_cam.ipynb index a0d189e1..39918043 100644 --- a/notebooks/troubleshooting/exercises/troubleshooting_cam.ipynb +++ b/notebooks/troubleshooting/exercises/troubleshooting_cam.ipynb @@ -123,10 +123,10 @@ "**# Change the job queue and account number**\n", "\n", "If needed, change `job queue` and `account number`.
\n", - "For instance, to run in the queue `tutorial` and the project number {{ PROJECT_CODE }} (you should use the project number given for this tutorial), use the command:\n", + "For instance, to run in the queue `tutorial` and the project number UCGD0011 (you should use the project number given for this tutorial), use the command:\n", "\n", - "``` {parsed-literal}\n", - "./xmlchange JOB_QUEUE={{ '`' + TUTORIAL_QUE + '`' }},PROJECT={{ '`' + PROJECT_CODE + '`' }} --force\n", + "```bash\n", + "./xmlchange JOB_QUEUE=tutorial,PROJECT=UCGD0011 --force\n", "```\n", "\n", "**# Build and submit**\n",