Tutorial title

Author: github-username

This notebook serves as a template for creating your own Earth Engine Community Tutorial using Python and Colab. Before proceeding, be sure to read Writing your own tutorial, as well as the Earth Engine Community Tutorials Style Guide.

To get started, replace Tutorial title and github-username above with your own. Then, replace the text in this cell with a few sentences describing what the user is going to learn in this tutorial. Be sure to include concise background information; only include what's helpful and relevant. When in doubt, leave it out!

IMPORTANT: Be sure not to modify the copyright header at the beginning of this tutorial.

Run me first

Run the following cell to initialize the API. The output contains instructions on how to grant this notebook access to Earth Engine using your account.

import ee

# Trigger the authentication flow.

# Initialize the library.

Additional instructions

Break up your tutorial into one section per task. Use text cells to describe each code block. Split code cells into small chunks which can be executed together.

You can find useful examples of how to render images, charts, and interactive maps in the Earth Engine Python API Colab Setup notebook.

Getting started

Before starting work on your tutorial:

  1. If you haven't already, Join GitHub.

  2. File a Tutorial proposal to discuss your idea with the maintainers.

  3. When your proposal is approved, fork the Earth Engine Community repository to your personal account.

  4. In Colab, click "File > Save a copy in GitHub", granting Colab permission to write to your personal repository as necessary.

  5. In the "Copy to GitHub" dialog that appears, select the master branch of the fork created above.

  6. Fill in the File path field with your tutorial path:


    Replace your-tutorial-name with a short filename, using only lowercase letters, numbers, and "-", preserving the ".ipynb" extension.

  7. Write your tutorial directly in the notebook, leaving the copyright cell intact, and updating the title cell.

Add images

Images should be uploaded to your fork in GitHub under the tutorials/your-tutorial-name folder created above. Images must be directly under that directory; nested subdirectories are not allowed (e.g., "tutorials/your-tutorial-name/~img/~cool-viz.jpg").

To refer to images uploaded in your tutorial, use Markdown's image syntax, referring to the filename of the image, without specifying its absolute path or full URL. For example:

![alt text](my-awesome-viz.jpg)

Submit tutorial for review

When your tutorial is ready for review:

  1. Follow GitHub's instructions on creating a pull request to request a review.

  2. After a maintainer assigns someone to review your notebook, work with them to finalize the content. When they approve the tutorial, they will publish it alongside the official Earth Engine developers documentation.