Updating to run with WRF-Hydro v5.4.0 release and new Docker images

List of changes
 - Training updated and working, supplemental still broken from packages they use
 - Github CI added to run run_training_notebooks.sh, which builds all non-supplemental trainings
 - Github CI has cron job to run every Monday morning
 - Pull Request Template Added

Author: scrasmussen

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+TYPE: choose one of [bugfix, fix, enhancement, feature, text only]
+
+KEYWORDS: approximately 3 to 6 words related to your commit
+
+SOURCE: Developer's name and affiliation
+
+DESCRIPTION OF CHANGES: One or more paragraphs describing problem, solution, and required changes.
+
+ISSUE: The GitHub Issue that this PR addresses. For example `Fixes ISSUE #123`
+
+TESTS CONDUCTED: Explicitly state if regression, integration, or unit tests were run before submitting.
+
+NOTES: Optional, as appropriate. Delete if not used.
+
+<!--
+ITEMS THAT MIGHT BE USEFUL TO CONSIDER
+ - Closes issue #xxxx
+ - Tests added (unit tests and/or regression/integration tests)
+ - Backwards compatible
+ - Documentation included
+--->

.github/workflows/training-ci.yml

@@ -0,0 +1,30 @@
+name: training
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: '0 2 * * 1'  # Every Monday at 2 AM UTC
+
+jobs:
+  docker-build:
+    name: Test training notebooks
+    if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Pull wrfhydro/training image
+        run: docker pull wrfhydro/training
+
+      - name: Run notebook tests inside container
+        run: |
+          docker run --rm \
+            -v ${{ github.workspace }}:/workspace \
+            -w /workspace \
+            -e CI_TESTING=true \
+            wrfhydro/training

.gitignore

@@ -3,5 +3,6 @@
 .Rhistory
 *.Rproj
 *.DS_Store
+.ipynb_checkpoints/
 dockerImages/
 data/

README.md

@@ -1,4 +1,6 @@
-#  WRF-Hydro <img src="https://ral.ucar.edu/sites/default/files/public/wrf_hydro_symbol_logo_2017_09_150pxby63px.png" width=100 align="left" />
+#  WRF-Hydro® <img src="https://ral.ucar.edu/sites/default/files/public/wrf_hydro_symbol_logo_2017_09_150pxby63px.png" width=100 align="left" />
+
+[![Training Status](https://github.com/NCAR/wrf_hydro_training/actions/workflows/training-ci.yml/badge.svg?branch=main)](https://github.com/NCAR/wrf_hydro_training/actions/workflows/training-ci.yml)
 
 ## Overview
 This repository contains lessons in the form of Jupyter notebooks focused on understanding the basic functionality of WRF-Hydro.
@@ -12,7 +14,7 @@ The easiest and recommended way to run these lessons is via the [wrfhydro/traini
 ### Where to get help and/or post issues
 If you have general questions about Docker, there are ample online resourves including the excellent Docker documentation at https://docs.docker.com.
 
-If you have questions about WRF-Hydro or these lessons please use the contact form on our website: https://ral.ucar.edu/projects/wrf_hydro/contact. 
+If you have questions about WRF-Hydro or these lessons please use the contact form on our website: https://ral.ucar.edu/projects/wrf_hydro/contact.
 
 If you have found a bug in these lessons please log an issue on the Issues page of the GitHub repository at https://github.com/NCAR/wrf_hydro_training/issues.
 
@@ -27,17 +29,24 @@ Each training container is specific to a release version of the WRF-Hydro source
 
 Issue the following command in your terminal to pull a specific version of the training corresponding to your code release version.
 
-`docker pull wrfhydro/training:v5.2.0-rc1`
+`$ docker pull wrfhydro/training:v5.2.0-rc1`
 
 **Step 3: Start the training container**
 Issue the following commnand in your terminal session to start the training Docker container.
 
-`docker run --name wrf-hydro-training -p 8888:8888 -it wrfhydro/training:v5.2.0-rc1`
+`$ docker run --name wrf-hydro-training -p 8888:8888 wrfhydro/training`
+
+Start in interative mode with persistent data
+`$ docker run --name wrf-hydro-training -it -v ./path/to/wrf_hydro_training:/home/docker/saved wrfhydro/training`
+
+Run training notebooks CI
+
+`$ docker run --name wrf-hydro-ci --rm -e CI_TESTING=true wrfhydro/training`
 
 **Note: If you have already started the training once you will need to remove the previous container using the command
-`docker rm wrf-hydro-training`**
+`$ docker rm wrf-hydro-training`**
 
-The container will start and perform a number of actions before starting the training. 
+The container will start and perform a number of actions before starting the training.
 
 1. The container will pull the model code
 2. The container will pull an example test case

lessons/training/Lesson-0-start.ipynb

@@ -57,24 +57,20 @@
     "\n",
     "Issue the following command in your terminal to pull a specific version of the training corresponding to your code release version. \n",
     "\n",
-    "`docker pull wrfhydro/training:v5.2.0-rc1`\n",
+    "`docker pull wrfhydro/training:v5.4.0`\n",
     "\n",
     "**Step 3: Start the training container**\n",
     "Issue the following command in your terminal session to start the training Docker container.\n",
     "\n",
-    "`docker run --name wrf-hydro-training -p 8888:8888 -it wrfhydro/training:v5.2.0-rc1`\n",
+    "`docker run --name wrf-hydro-training -p 8888:8888 -it wrfhydro/training:v5.4.0`\n",
     "\n",
     "The container will start and perform a number of actions before starting the training. \n",
     "\n",
     "**Note: If you have already started the training once you will need to remove the previous container using the command\n",
     "\n",
     "`docker rm wrf-hydro-training`\n",
     "\n",
-    "**Step 4: Connect to JupyterLab server using your browser**\n",
-    "\n",
-    "At the end of the container startup process an address and password will be printed to the terminal. The address and password are used to connect to JupyterLab. All training lesson notebooks in this container are in the `/home/docker/wrf-hydro-training/lessons` directory and can be opened in the JupyterLab environment.\n",
-    "\n",
-    "**Step 5: Running the lessons**\n",
+    "**Step 4: Running the lessons**\n",
     "\n",
     "To run the lessons you may either execute commands by running each cell of the notebooks (recommended). Alternatively, you may open a terminal in JupyterLab by selecting `File -> New -> Terminal` within JupyterLab and input the commands manually if you prefer. You can also use your own terminal by logging into the container with the command `docker exec -it wrf-hydro-training bash`.\n",
     "\n",
@@ -95,20 +91,13 @@
     "\n",
     "**Note: Port forwarding is setup with the `-p 8888:8888` argument, which maps your localhost port to the container port. If you already have something running on port 8888 on your localhost you will need to change this number**\n",
     "\n",
-    "© UCAR 2020"
+    "© UCAR 2025"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -122,7 +111,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.3"
+   "version": "3.12.2"
   },
   "toc": {
    "base_numbering": 1,