Tutorials update

Updates to the tutorial files based upon EPA internal technical peer review comments. Revisions include simplifying coding commands, adding more detailed comments, and suppressing warning messages.

Author: terrahaxton

examples/basics_tutorial.ipynb

@@ -26,7 +26,8 @@
     "- Scipy is required to define lognormal fragility curves\n",
     "- NetworkX is used to calculate topographic metrics\n",
     "- Geopandas is used to load geospatial data\n",
-    "- Matplotlib is used to create graphics"
+    "- Matplotlib is used to create graphics\n",
+    "- Warnings is used to suppress warning messages for features that will be addressed in future WNTR releases"
    ]
   },
   {
@@ -40,9 +41,24 @@
     "import networkx as nx\n",
     "import geopandas as gpd\n",
     "import matplotlib.pylab as plt\n",
+    "import warnings\n",
     "import wntr"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Suppress warning messages that will be addressed in future WNTR releases\n",
+    "warnings.filterwarnings(\"ignore\", message=\"Column names longer than 10 characters will be truncated when saved to \"\n",
+    "            \"ESRI Shapefile.\")\n",
+    "warnings.filterwarnings(\"ignore\", message=\"'crs' was not provided.  The output dataset will not have projection information defined and may not be usable in other systems.\")\n",
+    "warnings.filterwarnings(\"ignore\", message=\"Normalized/laundered field name:\")\n",
+    "warnings.filterwarnings(\"ignore\", message=\"Geometry is in a geographic CRS.\")"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -780,6 +796,7 @@
     "# Split pipe 123 \n",
     "wn = wntr.morph.split_pipe(wn, pipe_name_to_split='123', new_pipe_name='123_B', new_junction_name='123_node')\n",
     "# Add a leak to the new node which starts at hour 2 and ends at hour 12\n",
+    "# Note add_leak is only included in the hydraulic simulation when using the WNTRSimulator\n",
     "leak_node = wn.get_node('123_node')\n",
     "leak_node.add_leak(wn, area=0.05, start_time=2*3600, end_time=12*3600)"
    ]
@@ -958,7 +975,6 @@
     "wntr.network.write_geojson(wn, 'Net3')\n",
     "\n",
     "# Create a WaterNetworkModel from GeoJSON files\n",
-    "# The following code will produce UserWarnings: 'crs' was not provided\n",
     "# Check project folder to verify that files were written\n",
     "geojson_files = {'junctions': 'Net3_junctions.geojson',\n",
     "                 'tanks': 'Net3_tanks.geojson',\n",
@@ -986,7 +1002,6 @@
    "outputs": [],
    "source": [
     "# Create Shapefiles from the WaterNetworkModel\n",
-    "# The following code will produce UserWarnings: \"Column names longer than 10 characters will be truncated when saved to ESRI Shapefile.\"\n",
     "wntr.network.write_shapefile(wn, 'Net3')\n",
     "\n",
     "# Create a WaterNetworkModel from Shapefiles\n",
@@ -1490,17 +1505,17 @@
    "outputs": [],
    "source": [
     "# Define an earthquake scenario\n",
-    "wn = wntr.morph.scale_node_coordinates(wn, 1000)\n",
+    "wn1 = wntr.morph.scale_node_coordinates(wn, 1000)\n",
     "epicenter = (32000,15000) # x,y location\n",
     "magnitude = 6.5 # Richter scale\n",
     "depth = 10000 # m, shallow depth\n",
     "# Model the magnitude 6.5 earthquake scenario\n",
     "earthquake = wntr.scenario.Earthquake(epicenter, magnitude, depth)\n",
-    "distance = earthquake.distance_to_epicenter(wn, element_type=wntr.network.Pipe)\n",
+    "distance = earthquake.distance_to_epicenter(wn1, element_type=wntr.network.Pipe)\n",
     "# Get peak ground accelerations (PGAs) from earthquake scenario\n",
     "pga = earthquake.pga_attenuation_model(distance)\n",
     "# Plot the PGA for each link on the network\n",
-    "ax = wntr.graphics.plot_network(wn, link_attribute=pga, node_size=0, link_width=2, title=\"Peak ground acceleration\", link_colorbar_label='PGA (g)')"
+    "ax = wntr.graphics.plot_network(wn1, link_attribute=pga, node_size=0, link_width=2, title=\"Peak ground acceleration\", link_colorbar_label='PGA (g)')"
    ]
   },
   {
@@ -1707,7 +1722,7 @@
     "# Geospatial capabilities\n",
     "Geospatial data can be used within WNTR to build a WaterNetworkModel, associate geospatial data with nodes and links, and save simulation results to GIS compatible files.\n",
     "\n",
-    "**Note,  this example assumes the coordinate reference system (CRS) for the WaterNetworkModel and GIS data are in EPSG:4326 (lat/long). Geographic CRS are not suitable for measuring distance and the example will result in UserWarnings.  The example will be updated to use a projected CRS at a later date.**"
+    "**Note,  this example assumes the coordinate reference system (CRS) for the WaterNetworkModel and GIS data are in EPSG:4326 (lat/long). Geographic CRS are not suitable for measuring distance. The example will be updated to use a projected CRS at a later date.**"
    ]
   },
   {
@@ -1755,7 +1770,7 @@
    "metadata": {},
    "source": [
     "## Snap data\n",
-    "The `snap` function is used to find the nearest point or line to a set of points. "
+    "The `snap` function is used to find the nearest point or line to a set of points."
    ]
   },
   {