1a_Framework_Inspection.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "84e9735f",
   "metadata": {},
   "outputs": [],
   "source": [
    "#%run \"0a_Workspace_setup.ipynb\"\n",
    "%run \"0b_Create_poi_files.ipynb\""
   ]
  },
  {
   "cell_type": "markdown",
   "id": "21511ab5",
   "metadata": {
    "jp-MarkdownHeadingCollapsed": true
   },
   "source": [
    "## Map HRU's, segments and POIs as folium.map elements"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d992ff1d",
   "metadata": {},
   "source": [
    "#### Set mapping extent and base map elements\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "e676bca2",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Set approximate latitude, longitude and zoom level for subbasin is calculated for starting point of folium.map plot window.\n",
    "pfile_lat = hru_gdf['hru_lat'].mean()\n",
    "pfile_lon = hru_gdf['hru_lon'].mean()\n",
    "zoom = 7 #Can be ad"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "6e4ea6eb",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Set up a custom tile for base map\n",
    "\n",
    "# This can be tricky with syntax but if you go to this link you will find resources that have options beyond the few defualt options in folium leaflet. \n",
    "# http://leaflet-extras.github.io/leaflet-providers/preview/\n",
    "# These tiles will also work in the minimap, but can get glitchy if the same tile var is used in the minimap and the main map child object.\n",
    "\n",
    "USGStopo_layer = folium.TileLayer(tiles = 'https://basemap.nationalmap.gov/arcgis/rest/services/USGSTopo/MapServer/tile/{z}/{y}/{x}',\n",
    "                 attr = 'USGS_topo', zoom_start = zoom, name = \"USGSTopo\")\n",
    "USGSHydroCached_layer = folium.TileLayer(tiles = 'https://basemap.nationalmap.gov/arcgis/rest/services/USGSHydroCached/MapServer/tile/{z}/{y}/{x}',\n",
    "                 attr = 'USGSHydroCached', zoom_start = zoom, name = \"USGSHydroCached\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "395758d9",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Set up inset map\n",
    "# This requires folium plugins. (from folium import plugins)\n",
    "minimap = plugins.MiniMap(tile_layer= 'OpenStreetMap',\n",
    "                          #attr = 'USGS_topo', \n",
    "                          position='topleft',\n",
    "                          #zoom_level_offset=- 4,\n",
    "                          height = 200,\n",
    "                          width = 200,\n",
    "                          collapsed_height = 25,\n",
    "                          collapsed_width = 25,\n",
    "                          zoom_level_fixed = 5,\n",
    "                          toggle_display=True,\n",
    "                          #collapsed = True\n",
    "                         )"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "66149bc3-2732-4ad3-911a-66c030a50a55",
   "metadata": {},
   "outputs": [],
   "source": [
    "crs = hru_gdf.crs"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "4db74d32",
   "metadata": {},
   "source": [
    "## Create interactive HRU map"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "cc99fdf6",
   "metadata": {},
   "source": [
    "### Create new HRU folium.map"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "8d3131da-88ee-4fb9-a7ed-39d3547cb448",
   "metadata": {
    "jupyter": {
     "source_hidden": true
    }
   },
   "outputs": [],
   "source": [
    "#Style functions\n",
    "style_function_hru_map = lambda x: {'opacity': 1,\n",
    "                                    'fillColor': '#00000000',#'goldenrod',\n",
    "                                    'color' : 'tan',\n",
    "                                    'weight': 1.5}\n",
    "highlight_function_hru_map = lambda x: {'opacity' : .5,\n",
    "                                        'color':'gray',\n",
    "                                        'fillColor':'gray',\n",
    "                                        'weight': 3}\n",
    "style_function_seg_map = lambda x: {'opacity': 1,\n",
    "                                    'color': '#217de7',\n",
    "                                    'weight': 2}\n",
    "highlight_function_seg_map = lambda x: {'opacity' : 1,\n",
    "                                        'color':'white',\n",
    "                                        'weight': 4}\n",
    "transparent = lambda x: {'fillColor': '#00000000', \n",
    "                         'color': '#00000000',\n",
    "                         'weight': 4,\n",
    "                        }"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "2ca0667e",
   "metadata": {},
   "outputs": [],
   "source": [
    "from folium.features import DivIcon\n",
    "\n",
    "m2 = folium.Map(location=[pfile_lat, pfile_lon], \n",
    "               tiles = USGSHydroCached_layer,\n",
    "               zoom_start = zoom, width = '100%',\n",
    "               height = '100%',\n",
    "               control_scale = True,\n",
    "               )\n",
    "\n",
    "folium.TileLayer(tiles = 'https://basemap.nationalmap.gov/arcgis/rest/services/USGSTopo/MapServer/tile/{z}/{y}/{x}',\n",
    "                 attr = 'USGS_Topo', zoom_start = zoom, name = \"USGS Topography\", show = False).add_to(m2)\n",
    "\n",
    "#############################################################################################################################################################\n",
    "tooltip_hru=folium.GeoJsonTooltip(\n",
    "    fields= [\"nhm_id\",\"hru_segment_nhm\"],\n",
    "    aliases=[\"hru\",\" flows to segment\"],\n",
    "    labels=True,\n",
    "    #style=(\"background-color: #F0EFEF;border: 2px solid black;font-family: arial; font-size: 16px; padding: 10px;\"),# Note that this tooltip style sets the style for all tool_tips.\n",
    ")\n",
    "\n",
    "popup_hru=folium.GeoJsonPopup(\n",
    "    fields= [\"nhm_id\",\"hru_segment_nhm\"],\n",
    "    aliases=[\"hru\",\" flows to segment\"],\n",
    "    labels=True,\n",
    "    localize=False,\n",
    "    style=(\"font-size: 16px;\"),# Note that this tooltip style sets the style for all tool_tips.\n",
    "            #background-color: #F0EFEF;border: 2px solid black;font-family: arial; padding: 10px; background-color: #F0EFEF;\n",
    ")\n",
    "\n",
    "tooltip_seg=folium.GeoJsonTooltip(\n",
    "    fields= [\"nhm_seg\",\"tosegment_nhm\"],\n",
    "    aliases=[\"segment\",\"flows to segment\"], \n",
    "    labels=True,\n",
    ")\n",
    "popup_seg=folium.GeoJsonPopup(\n",
    "    fields= [\"nhm_seg\",\"tosegment_nhm\"],\n",
    "    aliases=[\"segment\",\"flows to segment\"], \n",
    "    labels=True,\n",
    "    localize=False,\n",
    ")\n",
    "\n",
    "# Create and add HRU and Segment maps\n",
    "#hru_gdf[['nhm_id','hru_segment_nhm']] = hru_gdf[['nhm_id','hru_segment_nhm']].astype(object)\n",
    "hru_map = folium.GeoJson(hru_gdf,style_function = style_function_hru_map,\n",
    "                         highlight_function = highlight_function_hru_map,\n",
    "                         name = \"NHM HRUs\",\n",
    "                         #tooltip=tooltip_hru,\n",
    "                         popup=popup_hru,\n",
    "                        ).add_to(m2)\n",
    "\n",
    "seg_map_show = folium.GeoJson(seg_gdf, \n",
    "                         style_function = style_function_seg_map,\n",
    "                         highlight_function = highlight_function_seg_map, # lambda feature: {\"fillcolor\": \"white\", \"color\": \"white\"},\n",
    "                         name = \"NHM Segments\",\n",
    "                        ).add_to(m2)\n",
    "\n",
    "# This makes a transparent layer that will always be on the top and so the tooltip is associated with this layer, and will also always be on top.\n",
    "seg_map_hide = folium.GeoJson(seg_gdf, \n",
    "                         style_function = transparent,\n",
    "                         highlight_function = highlight_function_seg_map, # lambda feature: {\"fillcolor\": \"white\", \"color\": \"white\"},\n",
    "                         name = \"NHM Segments\",\n",
    "                         #tooltip=tooltip_seg,\n",
    "                              popup=popup_seg\n",
    "                        ).add_to(m2)\n",
    "\n",
    "#add POI marker cluster child items for the map\n",
    "marker_cluster = MarkerCluster(\n",
    "    name='All the POIs',\n",
    "    overlay=True,\n",
    "    control=True,\n",
    "    icon_create_function=None,\n",
    "    disableClusteringAtZoom=7,\n",
    ")\n",
    "marker_cluster_label = MarkerCluster(\n",
    "    name='All the POIs labels',\n",
    "    overlay=True,\n",
    "    control=True,\n",
    "    show = False,# False will not draw the child upon opening the map, but have it to draw in the Layer control.\n",
    "    icon_create_function=None,\n",
    "    disableClusteringAtZoom=7,\n",
    ")\n",
    "\n",
    "#add non-poi gages marker cluster child items for the map\n",
    "non_marker_cluster = MarkerCluster(\n",
    "    name='Non-poi gages',\n",
    "    overlay=True,\n",
    "    control=True,\n",
    "    icon_create_function=None,\n",
    "    disableClusteringAtZoom=7,\n",
    ")\n",
    "non_marker_cluster_label = MarkerCluster(\n",
    "    name='Non-poi gage labels',\n",
    "    overlay=True,\n",
    "    control=True,\n",
    "    show = False,# False will not draw the child upon opening the map, but have it to draw in the Layer control.\n",
    "    icon_create_function=None,\n",
    "    disableClusteringAtZoom=7,\n",
    ")\n",
    "\n",
    "\n",
    "\n",
    "\n",
    "\n",
    "##add POI markers and labels using row df.interowss loop\n",
    "for idx, row in poi_gdf.iterrows():\n",
    "    text = f'{row[\"poi_id\"]}'\n",
    "    label_lat = row['latitude']#-0.01\n",
    "    label_lon = row['longitude']\n",
    "    \n",
    "    marker_label = folium.map.Marker([label_lat, label_lon], \n",
    "                                     icon=DivIcon(icon_size=(10, 10),#(150,36), \n",
    "                                                  icon_anchor=(0,0),\n",
    "                                                  html='<div style=\"font-size: 12pt; font-weight: bold\">%s</div>' % text)).add_to(marker_cluster_label)\n",
    "   \n",
    "    marker = folium.CircleMarker(location=[row['latitude'],row['longitude']],\n",
    "                                    name = row[\"poi_id\"],\n",
    "                                    popup = folium.Popup(f'<font size=\"3px\">{row[\"poi_id\"]} ({row[\"poi_agency\"]})<br>{row[\"poi_name\"]}<br> on <b>segment </b>{row[\"nhm_seg\"]}</font>',\n",
    "                                                         max_width = 280, \n",
    "                                                         max_height = 2000),\n",
    "                                    radius = 5,\n",
    "                                    weight = 2,\n",
    "                                    color = 'black',\n",
    "                                    fill = True,\n",
    "                                    fill_color = 'Yellow',\n",
    "                                    fill_opacity = 1.0).add_to(marker_cluster)\n",
    "\n",
    "#Add tool tips to map\n",
    "#hru_map.add_child(tooltip_hru)\n",
    "#seg_map_hide.add_child(tooltip_seg)\n",
    "\n",
    "marker_cluster.add_to(m2)\n",
    "marker_cluster_label.add_to(m2)\n",
    "\n",
    "##add Non-poi gage markers and labels using row df.interowss loop\n",
    "for idx, row in nwis_gages_aoi.iterrows():\n",
    "    if row['poi_id'] in additional_gages:\n",
    "    \n",
    "        text = f'{row[\"poi_id\"]}'\n",
    "        label_lat = row['latitude']#-0.01\n",
    "        label_lon = row['longitude']\n",
    "        \n",
    "        marker_label = folium.map.Marker([label_lat, label_lon], \n",
    "                                         icon=DivIcon(icon_size=(10, 10),#(150,36), \n",
    "                                                      icon_anchor=(0,0),\n",
    "                                                      html='<div style=\"font-size: 12pt; font-weight: bold\">%s</div>' % text)).add_to(marker_cluster_label)\n",
    "       \n",
    "        marker = folium.CircleMarker(location=[row['latitude'],row['longitude']],\n",
    "                                        name = row[\"poi_id\"],\n",
    "                                        popup = folium.Popup(f'<font size=\"3px\">{row[\"poi_id\"]} ({row[\"poi_agency\"]})<br>{row[\"poi_name\"]}<br></font>',\n",
    "                                                             max_width = 280, \n",
    "                                                             max_height = 2000),\n",
    "                                        radius = 5,\n",
    "                                        weight = 2,\n",
    "                                        color = 'black',\n",
    "                                        fill = True,\n",
    "                                        fill_color = 'Red',\n",
    "                                        fill_opacity = 1.0).add_to(marker_cluster)\n",
    "    else:\n",
    "        pass\n",
    "\n",
    "#Add tool tips to map\n",
    "#hru_map.add_child(tooltip_hru)\n",
    "#seg_map_hide.add_child(tooltip_seg)\n",
    "\n",
    "non_marker_cluster.add_to(m2)\n",
    "non_marker_cluster_label.add_to(m2)\n",
    "\n",
    "m2.add_child(minimap)\n",
    "plugins.Fullscreen(position='bottomleft').add_to(m2)\n",
    "folium.LayerControl(collapsed=True, position = 'bottomright').add_to(m2)\n",
    "\n",
    "con.print(f'')\n",
    "con.print(f'')\n",
    "con.print(f'')\n",
    "con.print(f\"The NHMx framework:\", style = \"u bold black\")\n",
    "con.print(f\"{pdb.dimensions.get('nhru').meta['description']} (nhru), {pdb.dimensions.get('nhru').meta['size']}\")\n",
    "con.print(f\"{pdb.dimensions.get('nsegment').meta['description']} (nsegment), {pdb.dimensions.get('nsegment').meta['size']}\")\n",
    "con.print(f\"{pdb.dimensions.get('npoigages').meta['description']} (npoigages), {pdb.dimensions.get('npoigages').meta['size']}\")\n",
    "\n",
    "m2\n"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "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.10.13"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}