add markdown notes

Author: tsutterley

examples/cmr_debug_regions.ipynb

@@ -4,7 +4,12 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### SlideRule CMR Debug"
+    "### SlideRule CMR Debug\n",
+    "A simple tool for checking CMR queries\n",
+    "- 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"
    ]
   },
   {
@@ -113,6 +118,13 @@
     "logging.debug(granule_list)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Select Granules to Plot on Map"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -156,6 +168,13 @@
     "    m.map.add_layer(polygon)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Get Granules from NSIDC S3"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -165,8 +184,6 @@
     "def s3_retrieve(granule, **kwargs):\n",
     "    # set default keyword arguments\n",
     "    kwargs.setdefault('asset','nsidc-s3')\n",
-    "    kwargs.setdefault('lon_key','reference_photon_lon')\n",
-    "    kwargs.setdefault('lat_key','reference_photon_lat')\n",
     "    kwargs.setdefault('index_key','time')\n",
     "    kwargs.setdefault('polygon',None)\n",
     "    # regular expression operator for extracting information from files\n",
@@ -178,15 +195,21 @@
     "    if (PRD == 'ATL03'):\n",
     "        segment_group = \"geolocation\"\n",
     "        segment_key = 'segment_id'\n",
+    "        lon_key = 'reference_photon_lon'\n",
+    "        lat_key = 'reference_photon_lat'\n",
     "        vnames = ['segment_id','delta_time','reference_photon_lat',\n",
     "            'reference_photon_lon']\n",
     "    elif (PRD == 'ATL06'):\n",
     "        segment_group = \"land_ice_segments\"\n",
     "        segment_key = 'segment_id'\n",
+    "        lon_key = 'longitude'\n",
+    "        lat_key = 'latitude'\n",
     "        vnames = ['segment_id','delta_time','latitude','longitude']\n",
     "    elif (PRD == 'ATL08'):\n",
     "        segment_group = \"land_segments\"\n",
     "        segment_key = 'segment_id_beg'\n",
+    "        lon_key = 'longitude'\n",
+    "        lat_key = 'latitude'\n",
     "        vnames = ['segment_id_beg','segment_id_end','delta_time',\n",
     "            'latitude','longitude']\n",
     "    # for each valid beam within the HDF5 file\n",
@@ -219,7 +242,6 @@
     "    except:\n",
     "        return sliderule.icesat2.__emptyframe()\n",
     "    # convert to a GeoDataFrame\n",
-    "    lon_key,lat_key = (kwargs['lon_key'],kwargs['lat_key'])\n",
     "    geometry = gpd.points_from_xy(df[lon_key], df[lat_key])\n",
     "    gdf = gpd.GeoDataFrame(df.drop(columns=[lon_key,lat_key]),\n",
     "        geometry=geometry,crs='EPSG:4326')\n",
@@ -270,16 +292,10 @@
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": null,
+   "cell_type": "markdown",
    "metadata": {},
-   "outputs": [],
    "source": [
-    "# fix int columns that were converted in objects\n",
-    "fixed = gdf.drop(columns=['geometry'])\n",
-    "for column in fixed.select_dtypes(include='object').columns:\n",
-    "    fixed[column] = fixed[column].astype(\"int32\")\n",
-    "fixed = gpd.GeoDataFrame(fixed,geometry=gdf.geometry,crs='EPSG:4326')"
+    "#### Add Granule Track Polylines to Map"
    ]
   },
   {
@@ -288,6 +304,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# fix int columns that were converted in objects\n",
+    "fixed = gdf.drop(columns=['geometry'])\n",
+    "for column in fixed.select_dtypes(include='object').columns:\n",
+    "    fixed[column] = fixed[column].astype(\"int32\")\n",
+    "fixed = gpd.GeoDataFrame(fixed,geometry=gdf.geometry,crs='EPSG:4326')\n",
     "# convert from points to linestrings grouping by track\n",
     "grouped = fixed.groupby(['track'])['geometry'].apply(\n",
     "    lambda x: LineString(x.tolist()) if x.size > 1 else x.tolist())\n",