Skip to content

Commit

Permalink
update student version with curriculum book changes
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 4, 2024
1 parent 0f64837 commit 814e8c7
Show file tree
Hide file tree
Showing 26 changed files with 174,671 additions and 181,456 deletions.
43 changes: 38 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions STUDENT_README.md
Original file line number Diff line number Diff line change
@@ -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.
14 changes: 8 additions & 6 deletions book/Chapter2-DataManipulation/2.1_Data_Definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,17 @@ In geosciences, data come in multiple modalities depending on the source, nature


* **In-situ Data**: Measurements taken directly at the site of interest. In-situ data often comes as time series. Examples include:
* Temperature readings from weather stations.
* Seismic wave data from seismographs.
* Soil moisture content from field sensors.
* Temperature data from weather stations.
* Ground motion data from seismometer.
* Soil moisture data from *in-situ* probes.
* **Remote Sensing Data**: Collected from instruments not in direct contact with the object of study, often using satellites, drones, or aircraft. *Geospatial Data* are tied to specific locations on Earth’s surface, often represented as maps or grids (e.g., GIS data). Examples include:
* Spectral data (e.g., multispectral or hyperspectral images) from satellites.
* Images at multiple wavelengths (e.g., multispectral or hyperspectral images) from satellites.
* Topography data using LiDAR or radar systems.
* Sea surface temperature from satellites.
* **Model Data**: Simulated data generated from computational models. For example:
* Climate models predicting future temperatures or precipitation.
* Climate models predicting future temperatures, precipitation, chemistry.
* Hydrological models simulating water flow in river basins.
* Wavefield simulations that solve the wave equation in complex media
* **Geophysical Data**: Subsurface measurements derived through indirect methods like seismic surveys, gravity, or magnetic studies.


Expand All @@ -50,7 +51,8 @@ Geoscientific data is typically stored in formats that optimize storage, access,

**Shapefiles**: A vector data format for geographic information system (GIS) software, which contains geometric locations and attribute information of spatial features.

Most of these files are not cloud optimized, and we will explore next new format to accomodate large cloud storage systems.
**Cloud Optimized Formats**: As large archives are moving to cloud systems, other formats are becoming useful: COGT (Cloud Optimized GeoTiffs), Zarr, TileDB among others.


## Arrays
An array is a fundamental data structure used to store collections of values, often representing multidimensional data (e.g., gridded spatial data). Arrays in geosciences typically represent data like temperature, pressure, or rainfall on a grid.
Expand Down
Loading

0 comments on commit 814e8c7

Please sign in to comment.