Merge pull request planetlabs#118 from planetlabs/imports-notebook-112

Imports notebook 112

Author: jreiberkyle

CONTRIBUTING.md

@@ -1,16 +1,39 @@
 # Contributing to Notebooks
 
-## Notebook Naming
+# Notebooks
 
-Notebooks cannot have spaces in the paths. Use underscores instead. This is
+## Names
+
+Notebook filenames cannot have spaces. Use underscores instead. This is
 because pytest does not like spaces in command line arguments.
 
-## Docker Image Validation
+## Dependencies
+
+When a new notebook has a dependency that is not yet supported by the Docker image,
+a new Docker image must be built. Additionally, add the new dependency to the 
+[imports_test notebook](development-notebooks/imports_test.ipynb).
+
+## Skipping Validation
+
+To enable validation of the Docker image, every notebook should run successfully
+when run from the command line. For notebooks where that just is not possible, 
+the notebooks can be excluded from automated running by adding its path to 
+[tests/skip_notebooks](tests/skip_notebooks). Excluding a notebook from automated running
+means that it is excluded from Docker Image validation. **If a notebook is
+skipped, it will not be guaranteed to be supported by the Docker image.**
+
+# Docker Image
+
+## Validation
+
+**Every time** the Docker image is changed, at the very least ensure that the 
+python packages still import without error by running the
+[imports_test notebook](development-notebooks/imports_test.ipynb).
 
-The docker image must be able to run all notebooks. Whenever a change is made to
-the docker image, it must be validated. This can be accomplished by automatically
-running all of the notebooks using the supplied test script. This is accomplished
-by running the notebook in interactive mode, achieved by adding `/bin/bash` to 
+It is also strongly recommended that you ensure the Docker image can run all
+of the notebooks in the repository. This can be accomplished by automatically
+running all of the notebooks using the supplied test script. To run the test script,
+run the notebook in interactive mode, achieved by adding `/bin/bash` to 
 the container run command, e.g.
 ```bash
 docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan/work -e PL_API_KEY='[YOUR-API-KEY]' planet-notebooks /bin/bash
@@ -35,14 +58,10 @@ From the root directory within the docker container, run one of the following:
     $> pytest tests/test_notebooks.py --notebooks "$(grep -rl import <package> jupyter-notebooks/)"
    ```
 
-## Automated Running and Skipping
-
-To enable validation of the Docker image, every notebook should run successfully
-when run from the command line. For notebooks where that just is not possible, 
-the notebooks can be excluded from automated running by adding its path to 
-`tests/skip_notebooks`. Excluding a notebook from automated running
-means that it is excluded from Docker Image validation. **If a notebook is
-skipped, it will not be guaranteed to be supported by the Docker image.**
+## Skipping Notebooks
 
-Skipping of notebooks within `skip_notebooks` can be achieved with by adding the
-`--no-skip` option to the pytest command.
+Some notebooks are purposefully skipped in the validation process because they
+do not run successfully from the command line. These notebooks are specified in
+[tests/skip_notebooks](tests/skip_notebooks). Skipping of notebooks within
+`skip_notebooks` can be disabled by adding the `--no-skip` option to the pytest
+command.

development-notebooks/imports_test.ipynb

@@ -0,0 +1,79 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Imports Test\n",
+    "\n",
+    "This notebook imports all of the dependencies in this repo to identify any import errors. The purpose of this notebook is to provide some basic testing for development involving the Docker image.\n",
+    "\n",
+    "Every once in a while, check to see all these packages are used\n",
+    "\n",
+    "```\n",
+    "find . -type f -print0 | xargs -0 grep \"import <package>\"\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# please keep this in alphabetical order\n",
+    "import cv2\n",
+    "import fiona\n",
+    "import geojson\n",
+    "import geojsonio\n",
+    "import geopandas\n",
+    "import ipyleaflet\n",
+    "import ipywidgets\n",
+    "import matplotlib\n",
+    "import mercantile\n",
+    "import numpy\n",
+    "from osgeo import gdal, osr\n",
+    "import pandas\n",
+    "import planet\n",
+    "import pyproj\n",
+    "import pytest\n",
+    "import rasterio\n",
+    "import requests\n",
+    "import scipy\n",
+    "import shapely\n",
+    "import six # python2/3 compatibility\n",
+    "import skimage\n",
+    "import sklearn\n",
+    "import tqdm"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

jupyter-notebooks/webtiles/visualize_imagery_over_time.ipynb

@@ -15,23 +15,6 @@
     "## Setup"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Install additional dependencies\n",
-    "If you don't already have mercantile in your current jupyter environment, you can install it now."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install mercantile"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -388,7 +371,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.7"
+   "version": "3.7.6"
   }
  },
  "nbformat": 4,

planet-notebook-docker/requirements.txt

@@ -1,18 +1,15 @@
+# changes here should be reflected in 
+#    ../development-notebooks/imports_test.ipynb
 # please keep this in alphabetical order
-bokeh
-cartopy
-datashader
-descartes
 fiona
 gdal
 geojson
 geojsonio
 geopandas
-geoviews
-hvplot
 ipyleaflet
 ipywidgets
 matplotlib 
+mercantile
 numpy 
 # for pip, use opencv-python
 opencv