update student version with curriculum book changes

.github/actions/studentversion/action.yaml

@@ -20,10 +20,14 @@ runs:
         python -m pip install --upgrade pip
         pip install pyyaml
         
-    - name: execute py script # run clean_book.py
+    - name: execute py cleaning script # run clean_book.py
       shell: bash
       run: python .github/workflows/clean_book.py
 
+    - name: execute py replacement script # run replace_readme.py
+      shell: bash
+      run: python .github/workflows/replace_readme.py
+
     - name: commit files
       shell: bash
       run: |

.github/workflows/replace_readme.py

@@ -0,0 +1,17 @@
+import shutil
+import os
+
+def replaceFile(target, replacement):
+  print(f"\nAttempting to replace {target} with {replacement}...")
+
+  try:
+    shutil.copyfile(replacement, target) # copy the content of the source file to the destination file
+    os.remove(replacement) # delete the source file
+
+    print(f"Content from '{replacement}' has been copied to '{target}', '{replacement}' has been deleted.")
+  except FileNotFoundError:
+    print(f"One or both of {target, replacement} does not exist.")
+  except Exception as e:
+    print(f"An unknown error occurred: {e}")
+
+replaceFile("README.md", "STUDENT_README.md")

README.md

@@ -1,17 +1,35 @@
-# GeoSMART Curriculum Jupyter Book Site (ESS 469/569)
+# GeoSMART Curriculum Jupyter Book (ESS 469/569)
 
 [![Deploy](https://github.com/geo-smart/curriculum-book/actions/workflows/deploy.yaml/badge.svg)](https://github.com/geo-smart/curriculum-book/actions/workflows/deploy.yaml)
 [![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://geo-smart.github.io/curriculum-book)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/curriculum-book/HEAD?urlpath=lab)
 [![GeoSMART Library Badge](book/img/curricula_badge.svg)](https://geo-smart.github.io/curriculum)
 [![Student Version](book/img/student_version_badge.svg)](https://geo-smart.github.io/curriculum-book-student/)
 
-## About
+## Repository Overview
 
-This repository stores configuration for GeoSMART curriculum content, specifically the teacher version of the book. Only this version of the book should ever be edited, as the student version is automatically generated on push.
+This repository stores configuration for GeoSMART curriculum content, specifically the teacher version of the book. Only this version of the book should ever be edited, as the student version is automatically generated on push by github actions.
 
-## Serving
+## Making Changes
 
-Activate the `curriculum_book` conda environment (or any conda environment that has the necessary jupyter book dependencies). Navigate to the root folder of the curriculum book repository in anaconda prompt. Run `python server.py`.
+Edit the book content by modifying the `_config.yml`, `_toc.yml` and `*.ipynb` files in the `book` directory. The book is hosted on Github Pages and will be automatically updated on push, and the student book will also be created automatically on push.
 
-The server code can take a `--no-build` flag (or `--nb` shorthand) if you don't want to build any changes you've made to the notebooks, and this can just be run from a regular terminal.
+To modify the exact differences between this book and the student book, edit `.github/workflows/clean_book.py`. When you push, a github action will clone the repo and run this python file which modifies certain parts of `*.ipynb` file contents, then pushes to the student repo. To edit the student repo's README, edit `STUDENT_README.md`. The Github Actions workflow also automatically replaces `README.md` with `STUDENT_README.md` in the student repo.
+
+### `Student Response Sections`
+
+One modifications made by the `clean_book.py` workflow is to clear sections marked for student response. Code cells marked for student response may contain code in the teacher version of the book, but will have their code removed and replaced with a TODO comment in the student version.
+
+To mark a code cell to be cleared, insert a markdown cell directly preceding it with the following content:
+
+````markdown
+```{admonition} Student response section
+This section is left for the student to complete.
+```
+````
+
+## Serving Locally
+
+Activate the `curriculum_book` conda environment (or any conda environment that has the necessary jupyter book dependencies). Navigate to the root folder of the curriculum book repository in anaconda prompt, then run `python server.py`.
+
+On startup, the server will run `jb build book` to build all changes to the notebook and create the compiled HTML. The server code can take a `--no-build` flag (or `--nb` shorthand) if you don't want to build any changes you've made to the notebooks. In the case that you don't want to build changes made to the notebooks, you can just run `python serer.py --nb` from any terminal with python installed.

STUDENT_README.md

@@ -0,0 +1,10 @@
+# GeoSMART Curriculum Jupyter Book (ESS 469/569)
+
+[![Deploy](https://github.com/geo-smart/curriculum-book-student/actions/workflows/deploy.yaml/badge.svg)](https://github.com/geo-smart/curriculum-book-student/actions/workflows/deploy.yaml)
+[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://geo-smart.github.io/curriculum-book-student)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/curriculum-book-student/HEAD?urlpath=lab)
+[![GeoSMART Library Badge](book/img/curricula_badge.svg)](https://geo-smart.github.io/curriculum)
+
+## About
+
+This repository stores configuration for GeoSMART curriculum content, specifically the student version of the book. This version of the book should never be directly edited, as the student version is automatically generated on push.