About the GeoSMART Use Case Library

General Overview

The GeoSMART use case library is a collection of books demonstrating various machine learning workflows relevant to the geosciences, with the goal of fostering further adoption and growth in the space. Books in the library can be identified by the badge:

Contributing Content

Tutorial content can be integrated into jupyterbooks in one of two ways:

• Do it yourself (use this template book and add your content)

• Provide use your content (preferably in a github repo) and we will integrate it

The goal is to provide executable code on some platform. The contributor can choose between:

• Binder

• Google Colab

• Free AWS (smaller cloud-based examples) If none of the above options work for you, please contact us directly to discuss further.

Technical Details

The following section is dedicated to helping anyone who might be looking to use this template to contribute a use case. We recommend that you clone this navigating to use case template repository and clicking the “Use this template” button, the follow along locally. Much of the important information for succesufully using the template is in README.md files, and familiarizing oneself with the project structure is also important.

The .github folder already contains the github actions that will handle CI/CD deployment to github pages. There is no need to create a gh-pages branch, the first run of the github actions should handle that automatically.

The binder folder should store symlink(s) to environment configuration files in the conda folder. We recommend you use a package manager to both make your work more reproducible and make running your work with Binder as painless as possible. See the conda/README.md file for more detailed information.

The book folder houses the content of the project. Inside there, you will find two very important files, _config.yml and _toc.yml. The config file tells jupyter how to compile your notebook to html (for display on github pages). You probably won’t need to change anything in here except the title, author and website_url. The table of contents file will require some more changes. We have already laid out a basic project structure, and we recommend you at least look through it, even if you don’t end up following it exactly. Chapters can contain more than one file, although if you want to make significant changes you should check this page out first.