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.5_version_control_git.md

@@ -1,6 +1,6 @@
 # 1.5 Version Control & GitHub
 
-
+---
 ## Version Control
 Version Control is a system that organize and tracks the version of codes.
 
@@ -14,6 +14,7 @@ alt: PhD Comics, Version Control of a PhD
 Versions of a research paper. File nameing and tracked changes can become messy. From PhD Comics.
 ```
 
+
 It keeps track of the changes and who made the changes. See further discussion on [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/vcs/vcs-workflow.html) {cite:p}`the_turing_way_community_2022_6909298`. Here are the main points.
 
 

book/Chapter1-GettingStarted/1.6_data_gallery.md

@@ -37,9 +37,15 @@ The collection of data aims to represent the diversity of data sets encountered
 
 The data includes time series of various time scales (from the second to the 100ka). The data is stored either in CSV files for the class, but typically is stored in CSV, Arrow, H5, NetCDF, TileDB, mseed and other disciplinary-specific format.
 
-<div style="text-align: center;">
-  <img src="geocast-alldata.png" alt="Geoscience Temporal Data" style="width:80%;">
-  <p><em>Figure 1: Geoscience Temporal Data: x-axis represent time normalized, y-axis is normalized time series offset by indexing in the data set. The data sets includes extreme events, dynamic seismic waves, CO2 rising, seasonal patern over 15+ years such as hydrological and weather signals.</em></p>
-</div>
-
-
+<!-- For Vscode -->
+![Geoscientific Temporal Data](geocast-alldata.png)
+
+<!-- For Jupyter Book -->
+```{figure} geocast-alldata.png
+:width: 400px
+---
+name: Geoscientific Temporal Data 
+alt: PhD Comics, Version Control of a PhD
+---
+```
+*Figure 1: Geoscience Temporal Data: x-axis represent time normalized, y-axis is normalized time series offset by indexing in the data set. The data sets includes extreme events, dynamic seismic waves, CO2 rising, seasonal pattern over 15+ years such as hydrological and weather signals.*

book/Chapter1-GettingStarted/version_control_slides.md

@@ -0,0 +1,3 @@
+---
+marp: true
+----