update student version with curriculum book changes

README.md

@@ -1,10 +1,43 @@
 # GeoSMART Curriculum Jupyter Book (ESS 469/569)
 
-[![Deploy](https://github.com/geo-smart/mlgeo-book/actions/workflows/deploy.yaml/badge.svg)](https://github.com/geo-smart/mlgeo-book/actions/workflows/deploy.yaml)
-[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://geo-smart.github.io/mlgeo-book)
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/mlgeo-book/HEAD?urlpath=lab)
+[![Deploy](https://github.com/geo-smart/mlgeo-instructor/actions/workflows/deploy.yaml/badge.svg)](https://github.com/geo-smart/mlgeo-instructor/actions/workflows/deploy.yaml)
+[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://geo-smart.github.io/mlgeo-instructor)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/mlgeo-instructor/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/mlgeo-book/)
 
-## About
+## Repository Overview
 
-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.
+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.
+
+## Making Changes
+
+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.
+
+Making changes requires that you set up a conda environment and build locally before making sure that it will build with github actions. We accepted rendered notebooks, but some oddities, such as kernels different than python, will make it crash. So we recommend that contributors first build the book with the added notebooks.
+
+```sh
+    conda env create -f ./conda/environment.yml
+    conda activate curriculum_book
+
+```
+
+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/mlgeo-book/actions/workflows/deploy.yaml/badge.svg)](https://github.com/geo-smart/mlgeo-book/actions/workflows/deploy.yaml)
+[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://geo-smart.github.io/mlgeo-book)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/mlgeo-book/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.

book/Chapter1-GettingStarted/1.20_MLGEO_Final_Project.md

@@ -6,55 +6,55 @@
 
 ### **1. Report (5 Pages) - 40%**
 
-#### **Integration and Cohesion (10%)**
-- Clearly integrates AI-ready data preparation, CML, and DL components into a single narrative.
-- Demonstrates the logical progression of methods and their relevance to the geoscientific problem.
+-  **Integration and Cohesion (10%)**
+    - Clearly integrates AI-ready data preparation, CML, and DL components into a single narrative.
+    - Demonstrates the logical progression of methods and their relevance to the geoscientific problem.
 
-#### **Scientific Discussion and Interpretation (15%)**
-- Provides insightful analysis of results, including comparisons between CML and DL methods.
-- Discusses trade-offs, advantages, and limitations of the approaches used.
-- Includes domain-specific interpretations and implications of findings.
+- **Scientific Discussion and Interpretation (15%)**
+    - Provides insightful analysis of results, including comparisons between CML and DL methods.
+    - Discusses trade-offs, advantages, and limitations of the approaches used.
+    - Includes domain-specific interpretations and implications of findings.
 
-#### **Clarity and Organization (10%)**
-- The report is well-structured, concise, and within the 5-page limit (excluding references and appendices).
-- Includes high-quality figures, tables, and diagrams to support the narrative.
+- **Clarity and Organization (10%)**
+    - The report is well-structured, concise, and within the 5-page limit (excluding references and appendices).
+    - Includes high-quality figures, tables, and diagrams to support the narrative.
 
-#### **Team Contributions (5%)**
-- Clearly documents individual contributions from each team member to the report writing and analysis.
+- **Team Contributions (5%)**
+-   iting and analysis.
 
 ---
 
 ### **2. GitHub Repository - 35%**
 
-#### **Comprehensiveness (10%)**
-- Repository includes all three components: AI-ready data, CML, and DL.
-- Each component is complete and well-documented with code, results, and explanations.
+- **Comprehensiveness (10%)**
+    - Repository includes all three components: AI-ready data, CML, and DL.
+    - Each component is complete and well-documented with code, results, and explanations.
 
-#### **Reproducibility and Code Quality (10%)**
-- Code is modular, organized, and follows standard practices for AI/ML projects (e.g., using PyTorch for DL).
-- Instructions for reproducing results are clear (e.g., README with dependencies, instructions, and commands).
+- **Reproducibility and Code Quality (10%)**
+    - Code is modular, organized, and follows standard practices for AI/ML projects (e.g., using PyTorch for DL).
+    - Instructions for reproducing results are clear (e.g., README with dependencies, instructions, and commands).
 
-#### **Integration and Documentation (10%)**
-- Demonstrates integration across components with shared preprocessing steps, consistent evaluation metrics, and unified outputs.
-- Includes high-quality documentation that explains the project, methods, and findings holistically.
+- **Integration and Documentation (10%)**
+    - Demonstrates integration across components with shared preprocessing steps, consistent evaluation metrics, and unified outputs.
+    - Includes high-quality documentation that explains the project, methods, and findings holistically.
 
-#### **Team Contributions (5%)**
-- Repository reflects contributions from all team members (e.g., clear commit history, attribution in code/comments).
+- **Team Contributions (5%)**
+    - Repository reflects contributions from all team members (e.g., clear commit history, attribution in code/comments).
 
 ---
 
 ### **3. Presentation (10 Minutes) - 25%**
 
-#### **Content and Delivery (10%)**
-- Presentation provides a clear and engaging summary of the project, including objectives, methods, results, and key insights.
-- Demonstrates understanding of the methods and their relevance to the geoscientific problem.
+- **Content and Delivery (10%)**
+    - Presentation provides a clear and engaging summary of the project, including objectives, methods, results, and key insights.
+    - Demonstrates understanding of the methods and their relevance to the geoscientific problem.
 
-#### **Integration and Interpretation (10%)**
-- Focuses on the integration of all three components and the scientific conclusions derived from them.
-- Highlights key comparisons, domain-specific implications, and future directions.
+- **Integration and Interpretation (10%)**
+    - Focuses on the integration of all three components and the scientific conclusions derived from them.
+    - Highlights key comparisons, domain-specific implications, and future directions.
 
-#### **Team Contributions (5%)**
-- All team members participate in the presentation, demonstrating their understanding and contributions.
+- **Team Contributions (5%)**
+- A erstanding and contributions.
 
 ---