Vulnerability onboarding from Hazus hurricane; documentation update. (#…

…369) * Vulnerability onboarding from Hazus hurricane; documentation update. Signed-off-by: Joe Moorhouse <[email protected]> * Updates to vulnerability config generation from Hazus Hurricane source. Signed-off-by: Joe Moorhouse <[email protected]> --------- Signed-off-by: Joe Moorhouse <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
os-climate · Jan 4, 2025 · 638bc9f · 638bc9f
1 parent 2cf7555
commit 638bc9f
Show file tree

Hide file tree

Showing 17 changed files with 787 additions and 20 deletions.
diff --git a/docs/references.bib b/docs/references.bib
@@ -1,6 +1,90 @@
+@article{durst1960wind,
+  title={Wind speeds over short periods of time},
+  author={Durst, CS},
+  journal={Meteor. Mag},
+  volume={89},
+  number={1056},
+  pages={181--187},
+  year={1960}
+}
+
+@article{eberenz2020regional,
+  title={Regional tropical cyclone impact functions for globally consistent risk assessments},
+  author={Eberenz, Samuel and L{\"u}thi, Samuel and Bresch, David N},
+  journal={Natural Hazards and Earth System Sciences Discussions},
+  volume={2020},
+  pages={1--29},
+  year={2020},
+  publisher={G{\"o}ttingen, Germany}
+}
+
+@article{harper2010guidelines,
+  title={Guidelines for converting between various wind averaging periods in tropical cyclone conditions},
+  author={Harper, BA and Kepert, JD and Ginger, JD},
+  year={2010},
+  publisher={Citeseer}
+}
+
+@article{holmes2014gust,
+  title={Gust durations, gust factors and gust response factors in wind codes and standards},
+  author={Holmes, John D and Allsop, Andrew C and Ginger, John D},
+  journal={Wind and Structures},
+  volume={19},
+  number={3},
+  pages={339--352},
+  year={2014},
+  publisher={Techno-Press}
+}
+
 @techreport{huizinga2017global,
   title={Global flood depth-damage functions: Methodology and the database with guidelines},
   author={Huizinga, Jan and De Moel, Hans and Szewczyk, Wojciech},
   year={2017},
   institution={Joint Research Centre}
 }
+
+@article{paulsen2005examination,
+  title={An examination of tropical and extratropical gust factors and the associated wind speed histograms},
+  author={Paulsen, Becca M and Schroeder, John L},
+  journal={Journal of Applied Meteorology and Climatology},
+  volume={44},
+  number={2},
+  pages={270--280},
+  year={2005},
+  publisher={American Meteorological Society}
+}
+
+@techreport{hazus2024inventory,
+  title={Hazus Inventory Technical Manual, Hazus 6.1},
+  author={FEMA},
+  year={2024},
+  institution={FEMA}
+}
+
+@techreport{hazus2024hurricane,
+  title={Hazus Hurricane Model Technical Manual, Hazus 6.1},
+  author={FEMA},
+  year={2024},
+  institution={FEMA}
+}
+
+@article{sealy2017hurricane,
+  title={A hurricane loss risk assessment of coastal properties in the caribbean: Evidence from the Bahamas},
+  author={Sealy, Kathleen Sullivan and Strobl, Eric},
+  journal={Ocean \& coastal management},
+  volume={149},
+  pages={42--51},
+  year={2017},
+  publisher={Elsevier}
+}
+
+@article{vickery2009hurricane,
+  title={Hurricane hazard modeling: The past, present, and future},
+  author={Vickery, Peter J and Masters, Forrest J and Powell, Mark D and Wadhera, Dhiraj},
+  journal={Journal of Wind Engineering and Industrial Aerodynamics},
+  volume={97},
+  number={7-8},
+  pages={392--405},
+  year={2009},
+  publisher={Elsevier}
+}
diff --git a/docs/user_guide/hazard_indicators/hazard_indicators.rst b/docs/user_guide/hazard_indicators/hazard_indicators.rst
@@ -1,7 +1,7 @@
 Hazard indicators
 =================
 
-The following sections discuss hazard indicators.
+The following sections cover hazard indicators, starting with a description of the conventions for storing hazard indicator data sets. Subsequent sections provide documentation in addition to the hazards description in the hazard indicator inventory. Typically this is needed when non-trivial transformation is performed as part of an on-boarding task or if the hazard indicator is derived from an original model.
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/user_guide/hazard_indicators/indicators.ipynb b/docs/user_guide/hazard_indicators/indicators.ipynb
@@ -4,7 +4,52 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Hazard indicator conventions"
+    "# Hazard indicators and conventions\n",
+    "\n",
+    "Note that the xarray library already defines a convention for storing DataArrays as Zarr arrays.\n",
+    "https://docs.xarray.dev/en/latest/generated/xarray.Dataset.to_zarr.html\n",
+    "In this convention, the \n",
+    "\n",
+    "https://docs.xarray.dev/en/latest/user-guide/terminology.html#term-Indexed-coordinate"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 18,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "from dotenv import load_dotenv\n",
+    "import s3fs\n",
+    "\n",
+    "load_dotenv(\"../../../credentials.env\")\n",
+    "\n",
+    "bucket = os.environ.get(\"OSC_S3_BUCKET\")\n",
+    "s3 = s3fs.S3FileSystem(\n",
+    "    key=os.environ.get(\"OSC_S3_ACCESS_KEY\", None),\n",
+    "    secret=os.environ.get(\"OSC_S3_SECRET_KEY\", None),\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 19,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['physrisk-hazard-indicators/hazard', 'physrisk-hazard-indicators/hazard_test']"
+      ]
+     },
+     "execution_count": 19,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "s3.ls(bucket)"
    ]
   }
  ],
@@ -15,8 +60,16 @@
    "name": "python3"
   },
   "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
    "name": "python",
-   "version": "3.10.8"
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.15"
   }
  },
  "nbformat": 4,

diff --git a/docs/user_guide/vulnerability/sectorial_models.ipynb b/docs/user_guide/vulnerability/sectorial_models.ipynb
@@ -0,0 +1,36 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Sectorial models\n",
+    "\n",
+    "Sectorial modelling is the modelling of physical climate risk for sectors of economic activity. Different classifications exist; for example within the European Union, NACE codes are defined https://ec.europa.eu/eurostat/web/metadata/classifications.\n",
+    "It is assumed that the properties of the assets of a particular sector and region are not known in detail; the intent is rather to assign suitable vulnerability functions for the types of asset, the types being defined at a relatively coarse granularity.\n",
+    "\n",
+    "Sectorial models are suitable for:\n",
+    "- Comparative analyses (e.g. identification of most at-risk sectors/regions).\n",
+    "- Bottom-up quantitative estimates of impact on entities (e.g. companies) within a sector.\n",
+    "\n",
+    "Within `physrisk` sectorial models are defined in terms of the asset class, a 'type' field that provides a relatively\n",
+    "coarse-granularity classification and a 'location' field.\n",
+    "\n",
+    "Sectorial models are relevant to the subsequent sections that deal with inferring vulnerability functions from various sources.  "
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python",
+   "version": "3.10.15"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/docs/user_guide/vulnerability/vulnerability.rst b/docs/user_guide/vulnerability/vulnerability.rst
@@ -9,6 +9,7 @@ Vulnerability configuration is generated programmatically from a number of diffe
 
    vulnerability_config
    vulnerability_uncertainty
+   sectorial_models
 
 
 Vulnerability function sources
@@ -21,4 +22,11 @@ Flood
 
    vulnerability_functions/inundation_jrc/onboard
 
+Wind
+----
+.. toctree::
+   :maxdepth: 2
+
+   vulnerability_functions/wind_hazus/onboard
+
 .. bibliography::
diff --git a/docs/user_guide/vulnerability/vulnerability_config.ipynb b/docs/user_guide/vulnerability/vulnerability_config.ipynb
@@ -386,7 +386,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.8"
+   "version": "3.10.15"
   }
  },
  "nbformat": 4,

diff --git a/docs/user_guide/vulnerability/vulnerability_functions/inundation_hazus/hazus_occupancy.csv b/docs/user_guide/vulnerability/vulnerability_functions/inundation_hazus/hazus_occupancy.csv
@@ -0,0 +1,34 @@
+Hazus General Occupancy Class,Hazus Specific Occupancy Class,Class Description
+Residential,RES1,Single-family Dwelling
+Residential,RES2,Mobile Home
+Residential,RES3A,Multi-Family Dwelling – Duplex
+Residential,RES3B,Multi-Family Dwelling – 3-4 Units
+Residential,RES3C,Multi-Family Dwelling – 5-9 Units
+Residential,RES3D,Multi-Family Dwelling – 10-19 Units
+Residential,RES3E,Multi-Family Dwelling – 20-49 Units
+Residential,RES3F,Multi-Family Dwelling – 50+ Units
+Residential,RES4,Temporary Lodging
+Residential,RES5,Institutional Dormitory
+Residential,RES6,Nursing Home
+Commercial,COM1,Retail Trade
+Commercial,COM2,Wholesale Trade
+Commercial,COM3,Personal and Repair Services
+Commercial,COM4,Business/Professional/Technical Services
+Commercial,COM5,Depository Institutions (Banks)
+Commercial,COM6,Hospital
+Commercial,COM7,Medical Office/Clinic
+Commercial,COM8,Entertainment & Recreation
+Commercial,COM9,Theaters
+Commercial,COM10,Parking
+Industrial,IND1,Heavy
+Industrial,IND2,Light
+Industrial,IND3,Food/Drugs/Chemicals
+Industrial,IND4,Metals/Minerals Processing
+Industrial,IND5,High Technology
+Industrial,IND6,Construction
+Agriculture,AGR1,Agriculture
+Religion,REL1,Church/Non-Profit
+Government,GOV1,General Services
+Government,GOV2,Emergency Response
+Education,EDU1,Schools/Libraries
+Education,EDU2,Colleges/Universities