clean up readmes, move imports to requirements

Author: matthew-ballard

README.md

@@ -80,51 +80,35 @@ configure. To ease this complexity we provide a docker container for running the
 systems. To install docker on your system please see docker's [documentation](https://docs.docker.com/engine/installation/)
 for your operating system.
 
-### Download prebuilt Docker image (recommended)
-The Docker image for these notebooks is hosted in the [planetlabs/notebooks](https://hub.docker.com/r/planetlabs/notebooks) repo on DockerHub. To download and prepare the image for use, run:
+### 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
+repository, you run:
 ```bash
-cd notebooks
-docker pull planetlabs/notebooks
-docker tag planetlabs/notebooks planet-notebooks
-
-# If you get errors running the above, you might have to add sudo to the beginning:
-#sudo docker pull planetlabs/notebooks
-#sudo docker tag planetlabs/notebooks planet-notebooks
+docker build -t planet-notebooks planet-notebook-docker/
 ```
 
-If you want to re-build the Docker image yourself, this is documented below in the "Appendix: Build the Docker image" section.
+This will build and install the Docker image on your system, making it available to run. This may take some 
+time (from 10 minutes to an hour) depending on your network connection and how long Anaconda takes to configure
+its environment.
 
 ### Run the container
 To run the container (after building or downloading it), add your Planet API key below and issue the following command from the git repository root directory:
 
 ```bash
-docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan/work -e PL_API_KEY='[YOUR-API-KEY]' planet-notebooks
+docker run -it --rm -p 8888:8888 -v "$(pwd)/jupyter-notebooks:/home/jovyan/work" -e PL_API_KEY='your-key' planet-notebooks
 
 # If you get a permissions error running the above, you should add sudo to the front:
 # sudo docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan/work -e PL_API_KEY='[YOUR-API-KEY]' planet-notebooks
-# Windows users run: winpty docker run -it --rm -p 8888:8888 -v "/$PWD":/home/joyvan/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.
-
-1. Maps a host system path ```$PWD``` to the docker container's 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 you exit the container.
-This also allows for running tests in the `tests` sub-directory.
-
-1. Ensures that the directory in the Docker container named `/home/jovyan/work` that has the notebooks
-in them is accessible to the Jupyter notebook server.
-
-1. Starts an interactive terminal that is accessible through http://localhost:8888.
-
-1. Sets an environment variable with your unique Planet API key for authenticating against the API.
-
-1. Includes the ```--rm``` option to clean up the notebook after you exit the process.
+1. **Maps port 8888** - Makes the container accessible at http://localhost:8888
+2. **Mounts your notebooks** - Maps `jupyter-notebooks/` folder to `/home/jovyan/work` so your work persists and notebooks are accessible to Jupyter
+3. **Sets your API key** - Replace `your-key` with your actual Planet API key for API authentication
+4. **Starts interactive terminal** - Accessible through the web browser
+5. **Auto-cleanup** - Removes container when you exit (`--rm`)
 
 ### Open Jupyter notebooks
 Once the Docker container is running, the CLI output will display a URL that you will use to access Jupyter notebooks
@@ -133,82 +117,4 @@ with your browser.
 http://localhost:8888/?token=<UNIQUE-TOKEN>
 ```
 
-NOTE: This security token will change every time you start your Docker container.
-
-## Repository Organization
-
-### jupyter-notebooks
-
-#### exploring_planet_data: Working with our various image products, how to use the udm mask or deliver imagery to our GEE integration
-
-* [How to use the Data and Orders API to create analysis ready data](https://github.com/planetlabs/notebooks/tree/proserve_restructure/jupyter-notebooks/exploring_planet_data/analysis-ready-data)
-* [Converting Raster Results to Vector Features](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics-snippets/README.md)
-* [Introduction to Cloud Native Geospatial Tools](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/cloud-native-geospatial)
-* [Comparing Planet Scope with Landsat 8]()
-* [Deliver data to GEE](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/cloud-native-geospatial)
-* [Start working with satellite imagery in Python](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/cloud-native-geospatial)
-* [Create labels using Planet imagery](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/cloud-native-geospatial)
-* [Pixel-by-pixel comparison of PlanetScope and Landsat Scenes](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/landsat-ps-comparison/landsat-ps-comparison.ipynb)
-* [Visualize and convert a UDM to a binary mask](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/udm/udm.ipynb)
-* [Work with the Usable Data Mask (UDM2)](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/udm2)
-
-
-
-
-#### Search, activate, download with the Data API   
-* [Explore the Planet Data API with Python](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/data-api-tutorials/planet_data_api_introduction.ipynb)
-* [Search, activate, and download imagery with the Planet Python Client](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/data-api-tutorials/planet_python_client_introduction.ipynb)
-* [Search & Download Quickstart Guide](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/data-api-tutorials/search_and_download_quickstart.ipynb)
-* [Planet Data API reference](https://developers.planet.com/docs/apis/data/)
-
-#### Ordering, delivery, and tools with the Orders API
-* [Ordering and Delivery](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/orders_api_tutorials/ordering_and_delivery.ipynb)
-* [Tools and Toolchains](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/orders_api_tutorials/tools_and_toolchains.ipynb)
-* [Planet Orders API reference](https://developers.planet.com/docs/orders/)
-
-### Process Planet data
-* [Create a mosaic from multiple PlanetScope scenes](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/mosaicing/basic_compositing_demo.ipynb)
-* [Calculate a vegetation index from 4-band satellite imagery](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/ndvi/ndvi_planetscope.ipynb)
-* [Convert PlanetScope metadata from radiance to reflectance](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/toar/toar_planetscope.ipynb)
-
-
-### Analyze and visualize Planet data
-
-* Analytics quickstart:
-    1. [Summarizing Feeds and Subscriptions](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/quickstart/01_checking_available_feeds_and_subscriptions.ipynb)
-    2. [Getting Analytic Feed Results](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/quickstart/02_fetching_feed_results.ipynb)
-    3. [Visualizing Raster Results](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/quickstart/03_visualizing_raster_results.ipynb)
-* Analytics user guide:
-    1. [Getting Started with Planet Analytics API](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/user-guide/01_getting_started_with_the_planet_analytics_api.ipynb)
-    2. [Planet Analytic Feeds Results](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/user-guide/02_analytic_feeds_results.ipynb)
-    3. [Change Detection](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/user-guide/03_change_detection.ipynb)
-    4. [Summary Statistics - Buildings](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/user-guide/04_summary_statistics_buildings.ipynb)
-    5. [Summary Statistics - Ships and Clouds](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/user-guide/05_summary_statistics_ships_and_clouds.ipynb)
-* Other analytics notebooks:
-    * [Detect, count, and visualize ships in Planet imagery](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/ship-detector/01_ship_detector.ipynb)
-    * [Pixel-by-pixel comparison of PlanetScope and Landsat Scenes](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/landsat-ps-comparison/landsat-ps-comparison.ipynb)
-    * [Calculate Coverage for a Search Query](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/coverage/calculate_coverage.ipynb)
-    * [Segment and Classify Crops](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/crop-segmentation-and-classification)
-    * [Identify Forest Degradation](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/forest-monitoring)
-    * [Identify the Temporal Signature of Crops](https://github.com/planetlabs/notebooks/tree/master/jupyter-notebooks/temporal-analysis)
-
-    * [Creating a Heatmap of Vector Results](https://github.com/planetlabs/notebooks/blob/master/jupyter-notebooks/analytics/change_detection_heatmap.ipynb)
-
-
-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](https://github.com/planetlabs/notebooks/issues) and let us know.
-
-### Appendix: Build the Docker image
-
-This documents how to build the docker image yourself, rather than using the recommended step of downloading pre-built Docker images. This is useful if you are a developer adding dependencies or a new Jupyter notebook to this repo, for example.
-
-First you must build the docker image. Note, this only has to be done the first time you use it. After checking out the
-repository, you run:
-```bash
-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 (from 10 minutes to an hour) depending on your network connection and how long Anaconda takes to configure
-its environment.
+NOTE: This security token will change every time you start your Docker container.

planet-notebook-docker/Dockerfile

@@ -2,7 +2,7 @@
 # https://github.com/jupyter/docker-stacks/wiki/minimal-notebook-414b5d749704
 FROM quay.io/jupyter/minimal-notebook:8515ad39f045
 
-# install dependencies
+# Copy requirements file for package installation
 COPY requirements.txt /tmp/requirements.txt
 
 # libgl Required for opencv
@@ -18,14 +18,8 @@ USER $NB_UID
 RUN conda config --set channel_priority strict && \
     conda install -y -c conda-forge --file /tmp/requirements.txt
 
-# install the following libraries w/ pip to support analytics/user-guide nb's
-# build fails due to long conda solves when these dependencies are added to requirements.txt
-# see https://github.com/planetlabs/notebooks/issues/135 for more details
-# python -m pip as per https://github.com/pypa/pip/issues/5599
-RUN python -m pip install descartes geoviews
-
 # Attempts to avoid having to hardcode this failed.
 # ref: https://github.com/planetlabs/notebooks/issues/101
 ENV PROJ_LIB=/opt/conda/share/proj
 
-WORKDIR work
+WORKDIR /home/jovyan/work

planet-notebook-docker/README.md

@@ -1,6 +1,6 @@
-# Planet Notebook
+# Planet Notebooks Docker Instructions
 
-This image provides the dependencies for running jupyter notebooks in the [planetlabs/notebooks](https://github.com/planetlabs/notebooks) GitHub repository. A prebuilt version of this image can be downloaded from the [planetlabs/notebook](https://hub.docker.com/r/planetlabs/notebooks) dockerhub repo (recommended). Alternatively, this image can be built locally from the Dockerfile. The specifics of building and running this image are given in the planetlabs/notebooks GitHub [README.md](https://github.com/planetlabs/notebooks/blob/master/README.md) file.
+This image provides the dependencies for running jupyter notebooks in the [planetlabs/notebooks](https://github.com/planetlabs/notebooks) GitHub repository. This image must be built locally from the Dockerfile. The specifics of building and running this image are given in the planetlabs/notebooks GitHub [README.md](https://github.com/planetlabs/notebooks?tab=readme-ov-file#run-planet-notebooks-in-docker) file.
 
 This image is based on the [jupyter/minimal-notebook](https://hub.docker.com/r/jupyter/minimal-notebook/) image and additional tips on running the jupyter notebook can be found in the documentation for that image.
 

planet-notebook-docker/requirements.txt

@@ -1,17 +1,17 @@
-# changes here should be reflected in 
 # please keep this in alphabetical order
 cartopy
+descartes
 fiona
 gdal
 geojson
 geojsonio
 geopandas
+geoviews
 ipyleaflet
 ipywidgets
 matplotlib
 mercantile
 numpy
-# for pip, use opencv-python
 opencv
 pandas
 planet
@@ -24,3 +24,4 @@ scikit-learn
 sentinelhub
 shapely
 tqdm
+tslearn