Merge pull request #113 from ICESat2-SlideRule/cmr

jpswinski · web-flow · commit 7ebf1469a7c6 · 2022-11-18T07:30:46.000-05:00
can query by date in CMR polygon queries notebook
diff --git a/examples/cmr_debug_regions.ipynb b/examples/cmr_debug_regions.ipynb
@@ -9,7 +9,12 @@
     "- Creates a leaflet map for creating regions of interest\n",
     "- Queries CMR for granules and granule polygons\n",
     "- Plots granule polygons on map\n",
-    "- Retrieves and plots granule tracks on map"
+    "- Retrieves and plots granule tracks on map\n",
+    "\n",
+    "### Jupyter and SlideRule\n",
+    "[Jupyter widgets](https://ipywidgets.readthedocs.io) are used to set parameters for the SlideRule API.  \n",
+    "\n",
+    "Regions of interest for submitting to SlideRule are drawn on a [ipyleaflet](https://ipyleaflet.readthedocs.io) map.  "
    ]
   },
   {
@@ -49,7 +54,17 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Set ICESat-2 Product"
+    "### Set ICESat-2 Product \n",
+    "\n",
+    "- [ATL03: Global Geolocated Photon Data](https://nsidc.org/data/atl03)\n",
+    "- [ATL06: Land Ice Height](https://nsidc.org/data/atl06)\n",
+    "- [ATL08: Land and Vegetation Height](https://nsidc.org/data/atl08)\n",
+    "\n",
+    "### Interactive Mapping with Leaflet\n",
+    "\n",
+    "Interactive maps within the SlideRule python API are built upon [ipyleaflet](https://ipyleaflet.readthedocs.io).\n",
+    "\n",
+    "There are 3 projections available within SlideRule for mapping ([Global](https://epsg.io/3857), [North](https://epsg.io/5936) and [South](https://epsg.io/3031)).  "
    ]
   },
   {
@@ -62,13 +77,16 @@
     "icesat2.init(\"slideruleearth.io\", loglevel=logging.WARNING)\n",
     "icesat2.get_version()\n",
     "\n",
-    "# dropdown menu for ICESat-2 product\n",
-    "product_select = widgets.Dropdown(\n",
-    "    options=['ATL03','ATL06','ATL08'],\n",
-    "    description='Product:',\n",
-    "    disabled=False\n",
-    ")\n",
-    "display(product_select)"
+    "# display widgets for setting ICESat-2 parameters\n",
+    "# and the interactive map projection\n",
+    "SRwidgets = ipysliderule.widgets()\n",
+    "widgets.VBox([\n",
+    "    SRwidgets.product,\n",
+    "    SRwidgets.release,\n",
+    "    SRwidgets.start_date,\n",
+    "    SRwidgets.end_date,\n",
+    "    SRwidgets.projection\n",
+    "])"
    ]
   },
   {
@@ -84,8 +102,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# create ipyleaflet map in projection\n",
-    "m = ipysliderule.leaflet('Global', center=(-25.3,131))\n",
+    "# create ipyleaflet map in specified projection\n",
+    "m = ipysliderule.leaflet(SRwidgets.projection.value)\n",
     "m.map"
    ]
   },
@@ -102,13 +120,17 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "%%time\n",
     "# for each region of interest\n",
     "granule_list = []\n",
     "granule_polygons = []\n",
     "for poly in m.regions:\n",
     "    # polygon from map\n",
     "    resources,polygons = icesat2.cmr(polygon=poly,\n",
-    "        short_name=product_select.value,\n",
+    "        short_name=SRwidgets.product.value,\n",
+    "        time_start=SRwidgets.time_start,\n",
+    "        time_end=SRwidgets.time_end,\n",
+    "        version=SRwidgets.release.value,\n",
     "        return_polygons=True)\n",
     "    granule_list.extend(resources)\n",
     "    granule_polygons.extend(polygons)\n",
@@ -270,6 +292,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "%%time\n",
     "# granule resources for selected segments\n",
     "perf_start = time.perf_counter()\n",
     "gdf = sliderule.icesat2.__emptyframe()\n",
@@ -282,9 +305,6 @@
     "        gdf = gdf.append(future.result())\n",
     "\n",
     "# Display Statistics\n",
-    "perf_stop = time.perf_counter()\n",
-    "perf_duration = perf_stop - perf_start\n",
-    "print(\"Completed in {:.3f} seconds of wall-clock time\".format(perf_duration))\n",
     "print(\"Reference Ground Tracks: {}\".format(gdf[\"rgt\"].unique()))\n",
     "print(\"Cycles: {}\".format(gdf[\"cycle\"].unique()))\n",
     "print(\"Received {} segments\".format(gdf.shape[0]))"
@@ -343,7 +363,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,
diff --git a/sliderule/ipysliderule.py b/sliderule/ipysliderule.py
@@ -89,6 +89,19 @@ def __init__(self, **kwargs):
             style=self.style,
         )
 
+        # dropdown menu for ICESat-2 product
+        self.product = ipywidgets.Dropdown(
+            options=['ATL03','ATL06','ATL08'],
+            value='ATL03',
+            description='Product:',
+            description_tooltip=("Product: ICESat-2 data product "
+                "\n\tATL03: Global Geolocated Photon Data"
+                "\n\tATL06: Land Ice Height"
+                "\n\tATL08: Land and Vegetation Height"),
+            disabled=False,
+            style=self.style,
+        )
+
         # dropdown menu for setting data release
         self.release = ipywidgets.Dropdown(
             options=['003', '004', '005'],
