interactive notebooks from Planet Engineering
Clone or download
jreiberkyle Merge pull request #63 from planetlabs/automate-notebooks-32
Create tools for automatically running notebooks, change notebooks so they run successfully automatically, cache data for slow running notebooks. #32 #36
Latest commit 79ec432 Nov 6, 2018

README.md

Planet Interactive Guides

Join the chat at https://gitter.im/planetlabs/notebooks

In this repository, you'll find a collection of Jupyter notebooks from the software developers, data scientists, and developer advocates at Planet. These interactive, open-source (APLv2) guides are designed to help you explore Planet data, work with our APIs and tools, and learn how to extract information from our massive archive of high-cadence satellite imagery. We hope these guides will inspire you to ask interesting questions of Planet data. Need help? Find a bug? Please file an issue and we'll get back to you.

The basics: search, activate, download

Process Planet data

Analyze and visualize Planet data

Soon we hope to add notebooks from the researchers, technologists, geographers, and entrepreneurs who are already using Planet data to ask interesting and innovative questions about our changing Earth. If you're working with our imagery and have a notebook (or just an idea for a notebook) that you'd like to share, please file an issue and let us know.

Install and use these notebooks

System Prerequisites

Clone the repo:

git clone https://github.com/planetlabs/notebooks.git
cd notebooks

Run Planet Notebooks in Docker

Planet Notebooks relies on a complex stack of technologies that are not always easy to install and properly configure. To ease this complexity we provide a docker container for running the notebook on docker compatible systems. To install docker on your system please see docker's documentation for your operating system.

Build the Docker image

First you must build the docker image. Note, this only has to be done the first time you use it. After checking out the this repository, you run:

cd planet-notebook-docker
docker build --rm -t planet-notebooks .
cd ..

This will build and install the Docker image on your system, making it available to run. This may take some time (between 10 and 20 minutes) depending on your network connection.

Run the container

To run the container (after building it), add your Planet API key below and issue the following command from the git repository root directory:

docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan/work -e PL_API_KEY='[YOUR-API-KEY]' planet-notebooks

This does several things:

  1. Maps the docker container's 8888 port to your system's 8888 port. This makes the container available to your host systems web browser.

  2. Maps a host system path $PWD to the docker containers working directory. This ensures that the notebooks you create, edit, and save are available on your host system under the jupyter-notebooks sub-directory and are not destroyed when the you exit the container. This also allows for running tests in the tests sub-directory.

  3. Starts in an interactive terminal and is accessible through http://localhost:8888.

  4. Sets an environment variable with your unique Planet API key for authenticating against the API.

  5. Include the --rm option to clean up the notebook after you exit the process.

Open Jupyter notebooks

Once the Docker container is running, the CLI output will display a URL that you will use to access Jupyter notebooks with your browser.

http://localhost:8888/?token=<UNIQUE-TOKEN>

NOTE: This security token will change every time you start your Docker container.