Update README.md

ym2540 · Nov 18, 2020 · 56c30c1 · 56c30c1
1 parent 621aea4
commit 56c30c1
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,30 @@
 # GIS-based Subdivision-Redistribution Simulation (GISSR)
+
+
+### Table of Contents<br><br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[**1. Summary**](#1-Summary)<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[**2. Main Files and Jupyter Notebooks**](#2-Main Files)<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[**3. Data**](#3-Data Folder)<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[**4. Sample Results**](#4-Sample Results)<br><br>
+
+## 1. Summary
+This flooding model of Lower Manhattan was developed after this area experienced extreme flooding and devastation from Hurricane Sandy in 2012. Using historical trends of hurricanes in the area, elevation data and surface roughness, these files generate the extent of following throughout Lower Manhattan (south of 34th Street). The model also considers the increasing severity of storms and flooding due to climate change and projected sea level rise by 2050 and 2100.
+
+
+## 2. Main Files
+|     |     |
+| --- | --- |
+**Flood_Estimate.ipynb** | This code produces flood heights for given storm parameters. The code calculates surface volume functions that can relate the volume of water to the flood height at a given division. Using Manning's equation, it takes topographic data and storm parameter data to find the velocity and subsequently the volume of the water. These flood volumes are then redistributed by propagating to the nearby divisions, and the final flood heights for each division are determined.
+**Flood Height to Raster Processor.ipynb** | To visualize the flood height results from Flood_Estimate.ipynb, this code processes the csv data into raster data (.TIFF). These .TIFF files can be inputted into ArcGIS to create a map of the area and corresponding flooding (see image above). Note, the user must have arcpy installed on their device for this code to run. 
+**Surface Volume CSV Processor.ipynb** | This code generates Surface Volume .csv files that are used in the Flood Estimate code, taking digital elevation model files (.TIFF) of the LMN’s division. The resulting .csv files contain the volume of water above the surface of the DEM at different heights in increments of 0.25m between 0-3m and in increments of 0.5m from 3.5-6.5m.
+
+## 3. Data Folder
+|     |     |
+| --- | --- |
+**LM_div18** | DEM files for Lower Manhattan divided into 18 divisions
+**LM_div18_grouped** | DEM files grouped with the two divisions adjacent
+**NewSurfaceVolume** | Surface volume csv files generated from the Surface Volume CSV Processor
+**Surge_Data** | Storm parameters to calculate storm surge
+**BigU_LES_all.csv** | Numbered segments of coastline corresponding to BigU placement
+**LMN_Roughness.csv** | Surface roughness of Lower Manhattan
+**LMN_Slope.csv** | Ground slope of Lower Manhattan
+**LMN_div_low19.csv** |Adjusted division elevation for Lower Manhattan
+
+## Sample Results
+This folder includes .csv files of flood heights generated by single runs of Flood_Estimates.ipynb for cold and warm storms under unprotected and BigU conditions.