/sioc209-2024-sp

Primary LanguageJupyter NotebookCreative Commons Attribution Share Alike 4.0 InternationalCC-BY-SA-4.0

Deep Learning for Geo and Environmental Science

Course content and material for SIOC 209

Usage

Building the book

If you'd like to develop and/or build the Machine Learning for Geo and Environmental Science book, you should:

  1. Clone this repository
  2. Run pip install -r requirements.txt (it is recommended you do this within a virtual environment)
  3. (Optional) Edit the books source files located in the sioc209-2024-sp/ directory
  4. Run jupyter-book clean sioc209-2024-sp/ to remove any existing builds
  5. Run jupyter-book build sioc209-2024-sp/

A fully-rendered HTML version of the book will be built in sioc209-2024-sp/_build/html/.

Hosting the book

Please see the Jupyter Book documentation to discover options for deploying a book online using services such as GitHub, GitLab, or Netlify.

For GitHub and GitLab deployment specifically, the cookiecutter-jupyter-book includes templates for, and information about, optional continuous integration (CI) workflow files to help easily and automatically deploy books online with GitHub or GitLab. For example, if you chose github for the include_ci cookiecutter option, your book template was created with a GitHub actions workflow file that, once pushed to GitHub, automatically renders and pushes your book to the gh-pages branch of your repo and hosts it on GitHub Pages when a push or pull request is made to the main branch.

Building the slides

The slides require a RISE which needs an older version of Jupyter Notebook. To build the slides, you should:

  1. Clone this repository
  2. Run conda create -n <sio209_dev> -c conda-forge python=3.10 xarray netcdf4 cartopy jupyter-book rise jupyter_contrib_nbextensions notebook==6.5.6
  3. Activate your dev environment
  4. Run pip install tensorflow-metal scikit-learn gpflow inside that environment
  5. (Optional) Edit the slides source files located in the sioc209-2024-sp/slides/ directory
  6. Run jupyter nbconvert --to slides sioc209-2024-sp/slides/*.ipynb --reveal-prefix=reveal.js --SlidesExporter.reveal_scroll=True

Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.

Credits

This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.