Release 4.6.0 (#277)

* 260 update notebook using restoration utils (#268) * update restoration util construction * changelog entry * 274 update indp documentation (#275) * add parameter and also citation * changelog * update the markdown link * 272 local hazard tutorial (#276) * Added multiple hazards from local * added description * removed unused packages * added zip * updated zip * Update CHANGELOG.md * added tutorials.md * added files * Update _toc.yml * Update _toc.yml * Commercial buildings markdown and notebook added (#273) * Commercial buildings added * Adding changelog and references * Corrections * Update commercial_building_recovery.md * Update commercial_building_recovery.md * changelog --------- Co-authored-by: YONG WOOK KIM <[email protected]> Co-authored-by: Ya-Lan Yang <[email protected]> Co-authored-by: Vismayak Mohanarajan <[email protected]>
IN-CORE · Oct 11, 2023 · e11289e · e11289e
1 parent 2eccdaf
commit e11289e
Show file tree

Hide file tree

Showing 33 changed files with 1,041 additions and 83 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,20 @@ All notable changes to the INCORE documents generated by Sphinx package will be
 The format is based on [Keep a Changelog](http://keepachangelog.com/) 
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+
+## [4.6.0] - 2023-10-11
+
+### Added
+- Added commercial buildings markdown and notebook [#271](https://github.com/IN-CORE/incore-docs/issues/271)
+- Local hazard tutorial [#272](https://github.com/IN-CORE/incore-docs/issues/272)
+
+### Fixed
+- Broken notebook using restoration util class [#260](https://github.com/IN-CORE/incore-docs/issues/260)
+
+### Changed
+- Add additional input dataset and citation to INDP [#274](https://github.com/IN-CORE/incore-docs/issues/274)
+
+
 ## [4.5.0] - 2023-08-16
 
 ### Added

diff --git a/manual_jb/content/_config.yml b/manual_jb/content/_config.yml
@@ -1,9 +1,9 @@
-title: "IN-CORE Manual<br /><span style='color:grey;font-size:smaller;'>4.5.0<span>"
+title: "IN-CORE Manual<br /><span style='color:grey;font-size:smaller;'>4.6.0<span>"
 project: "IN-CORE Manual"
 author: IN-CORE Community
 copyright: "2023"  # Copyright year to be placed in the footer
 logo: images/resilience-logo.png
-version: "4.5.0"  # Version is not part of JB config, we use it for autobuild of incore-docs
+version: "4.6.0"  # Version is not part of JB config, we use it for autobuild of incore-docs
 exclude_patterns: [_build, .DS_Store, "**.ipynb_checkpoints"]
 
 repository:

diff --git a/manual_jb/content/_toc.yml b/manual_jb/content/_toc.yml
@@ -61,6 +61,7 @@ chapters:
     - file: notebooks/create_tornado/create_tornado.ipynb
     - file: notebooks/retrofit_plan_Joplin_2021_12_01/retrofit_plan_Joplin_2021_12_01.ipynb
     - file: notebooks/create_network_dataset/create_network_dataset.ipynb
+    - file: notebooks/create_local_hazard/create_local_hazard.ipynb
 - file: faq
 - file: workshops
   sections:

diff --git a/manual_jb/content/analyses.md b/manual_jb/content/analyses.md
@@ -7,38 +7,39 @@
 5. [Capital shocks](analyses/capital_shocks)
 6. [Combined wind wave surge building damage](analyses/combined_wind_wave_surge_building_dmg)
 7. [Combined wind wave surge building loss](analyses/combined_wind_wave_surge_building_loss)
-8. [Cumulative building damage](analyses/cumulative_building_dmg)
-9. [Electric power facility damage](analyses/epf_dmg)
-10. [Electric power facility repair cost](analyses/epf_repair_cost)
-11. [Electric power facility restoration](analyses/epf_restoration)
-12. [Electric power network functionality](analyses/epn_functionality)
-13. [Household-level housing sequential recovery](analyses/housing_household_recovery)
-14. [Galveston Computable General Equilibrium (CGE)](analyses/galveston_cge.md)
-15. [Housing recovery](analyses/housing_recovery)
-16. [Housing unit allocation](analyses/housingunitallocation)
-17. [Interdependent Network Design Problem](analyses/indp)
-18. [Joplin Computable General Equilibrium (CGE)](analyses/joplin_cge)
-19. [Joplin empirical restoration](analyses/joplin_empirical_restoration)
-20. [Mean damage](analyses/mean_dmg)
-21. [Multi-objective retrofit optimization](analyses/multi_retrofit_optimization)
-22. [Monte Carlo failure probability](analyses/mc_failure_prob)
-23. [Network cascading interdependency functionality](analyses/nci_functionality)
-24. [Nonstructural building damage](analyses/non_structural_building_dmg)
-25. [Pipeline damage](analyses/pipeline_dmg)
-26. [Pipeline damage with repair rate](analyses/pipeline_dmg_w_repair_rate)
-27. [Pipeline functionality](analyses/pipeline_functionality)
-28. [Pipeline repair cost](analyses/pipeline_repair_cost)
-29. [Pipeline restoration](analyses/pipeline_restoration)
-30. [Population dislocation](analyses/populationdislocation)
-31. [Portfolio recovery](analyses/portfolio_recovery)
-32. [Residential building recovery](analyses/residential_building_recovery)
-33. [Road damage](analyses/road_dmg)
-34. [Salt Lake City Computable General Equilibrium (CGE)](analyses/slc_cge.md)
-35. [Seaside Computable General Equilibrium (CGE)](analyses/seaside_cge)
-36. [Social Vulnerability](analyses/social_vulnerability)
-37. [Tornado electric power network (EPN) damage](analyses/tornadoepn_dmg)
-38. [Transportation recovery](analyses/transportation_recovery)
-39. [Water facility damage](analyses/waterfacility_dmg)
-40. [Water network functionality](analyses/wfn_functionality)
-41. [Water facility repair cost](analyses/water_facility_repair_cost)
-42. [Water facility restoration](analyses/water_facility_restoration)
+8. [Commercial building recovery](analyses/commercial_building_recovery)
+9. [Cumulative building damage](analyses/cumulative_building_dmg)
+10. [Electric power facility damage](analyses/epf_dmg)
+11. [Electric power facility repair cost](analyses/epf_repair_cost)
+12. [Electric power facility restoration](analyses/epf_restoration)
+13. [Electric power network functionality](analyses/epn_functionality)
+14. [Household-level housing sequential recovery](analyses/housing_household_recovery)
+15. [Galveston Computable General Equilibrium (CGE)](analyses/galveston_cge.md)
+16. [Housing recovery](analyses/housing_recovery)
+17. [Housing unit allocation](analyses/housingunitallocation)
+18. [Interdependent Network Design Problem](analyses/indp)
+19. [Joplin Computable General Equilibrium (CGE)](analyses/joplin_cge)
+20. [Joplin empirical restoration](analyses/joplin_empirical_restoration)
+21. [Mean damage](analyses/mean_dmg)
+22. [Multi-objective retrofit optimization](analyses/multi_retrofit_optimization)
+23. [Monte Carlo failure probability](analyses/mc_failure_prob)
+24. [Network cascading interdependency functionality](analyses/nci_functionality)
+25. [Nonstructural building damage](analyses/non_structural_building_dmg)
+26. [Pipeline damage](analyses/pipeline_dmg)
+27. [Pipeline damage with repair rate](analyses/pipeline_dmg_w_repair_rate)
+28. [Pipeline functionality](analyses/pipeline_functionality)
+29. [Pipeline repair cost](analyses/pipeline_repair_cost)
+30. [Pipeline restoration](analyses/pipeline_restoration)
+31. [Population dislocation](analyses/populationdislocation)
+32. [Portfolio recovery](analyses/portfolio_recovery)
+33. [Residential building recovery](analyses/residential_building_recovery)
+34. [Road damage](analyses/road_dmg)
+35. [Salt Lake City Computable General Equilibrium (CGE)](analyses/slc_cge.md)
+36. [Seaside Computable General Equilibrium (CGE)](analyses/seaside_cge)
+37. [Social Vulnerability](analyses/social_vulnerability)
+38. [Tornado electric power network (EPN) damage](analyses/tornadoepn_dmg)
+39. [Transportation recovery](analyses/transportation_recovery)
+40. [Water facility damage](analyses/waterfacility_dmg)
+41. [Water network functionality](analyses/wfn_functionality)
+42. [Water facility repair cost](analyses/water_facility_repair_cost)
+43. [Water facility restoration](analyses/water_facility_restoration)
diff --git a/manual_jb/content/analyses/commercial_building_recovery.md b/manual_jb/content/analyses/commercial_building_recovery.md
@@ -0,0 +1,88 @@
+# Commercial building recovery
+
+**Description**
+
+This analysis computes the recovery time needed for each commercial building from any damage states to receive the
+full restoration. Currently, supported hazards are tornadoes.
+
+The methodology incorporates the multi-layer Monte Carlo simulation approach and determines the two-step recovery
+time that includes delay and repair. The delay model was modified based on the REDi framework and calculated the
+end-result outcomes resulted from delay impeding factors such as post-disaster inspection, insurance claim,
+financing and government permit. The repair model followed the FEMA P-58 approach and was controlled by fragility
+functions.
+
+The outputs of this analysis is a CSV file with time-stepping recovery probabilities at the building level.
+
+**Contributors**
+
+- Science: Wanting Lisa Wang, John W. van de Lindt
+- Implementation: Wanting Lisa Wang and NCSA IN-CORE Dev Team
+
+**Related publications**
+
+- Wang, W.L., Watson, M., van de Lindt, J.W. and Xiao, Y., 2023. Commercial Building Recovery Methodology for Use
+        in Community Resilience Modeling. Natural Hazards Review, 24(4), p.04023031.
+
+**Input parameters**
+
+key name | type | name | description
+--- | --- | --- | ---
+`result_name` <sup>*</sup> | `str` | Result name | Name of the result dataset.
+`num_samples` <sup>*</sup> | `int` | Samples number | Number of sample scenarios.
+`seed` | `int` | Seed | Initial seed for the probabilistic model.
+`repair_key` | `str` | Repair key | A repair key to use in mapping dataset.
+
+**Input datasets**
+
+key name | type | name | description
+--- | --- | --- | ---
+`buildings` <sup>*</sup> | `ergo:buildingInventoryVer4`<br>`ergo:buildingInventoryVer5`<br>`ergo:buildingInventoryVer6`<br>`ergo:buildingInventoryVer7` | Building dataset |  A building dataset.
+`dfr3_mapping_set` <sup>*</sup> | `incore:dfr3MappingSet` | DFR3 Mapping Set | DFR3 Mapping Set.
+`sample_damage_states` <sup>*</sup> | `incore:sampleDamageState` | Damage states | Sample damage states.
+`mcs_failure` <sup>*</sup> | `incore:failureProbability` | MCS failure | mcs_failure.
+`delay_factors` <sup>*</sup> | `incore:buildingRecoveryFactors` | Delay factors | Delay impeding factors such as post-disaster inspection, insurance claim,<br>and government permit based on building's damage state. Provided by REDi framework.
+
+**Output datasets**
+
+key name | type | parent key              | name | description
+--- | --- |-------------------------| --- | ---
+`time_stepping_recovery` <sup>*</sup> | `incore:buildingRecovery` | `buildings` | Results                 | A dataset containing results (format: CSV)<br>with percentages of commercial building recovery.                 | A dataset containing results (format: CSV)<br>with percentages of commercial building recovery.
+`recovery` <sup>*</sup> | `incore:buildingRecoveryTime` | `buildings` |  Building Recovery Time  | A dataset containing results (format: CSV)<br>with commercial building recovery time.
+`total_delay` <sup>*</sup> | `incore:buildingRecoveryDelay` | `buildings` |  Building Recovery Delay | A dataset containing results (format: CSV)<br>with commercial building delay time.
+
+<small>(* required)</small>
+
+**Execution**
+
+code snippet:
+
+```
+    # Create Commercial building recovery instance
+    comm_recovery = CommercialBuildingRecovery(client)
+    
+    # Load input building infrastructure dataset
+    comm_recovery.load_remote_input_dataset("buildings", buildings)
+
+    # Load repair mapping
+    repair_service = RepairService(client)
+    mapping_set = MappingSet(repair_service.get_mapping(mapping_id))
+    comm_recovery.set_input_dataset('dfr3_mapping_set', mapping_set)
+    
+    # Load input datasets
+    com_recovery.load_remote_input_dataset("sample_damage_states", sample_damage_states)
+    com_recovery.load_remote_input_dataset("mcs_failure", mcs_failure)
+    com_recovery.load_remote_input_dataset("delay_factors", delay_factors)
+
+    # Specify the result name
+    result_name = "joplin_recovery"
+
+    # Set analysis parameters
+    comm_recovery.set_parameter("result_name", result_name)
+    comm_recovery.set_parameter("seed", seed)
+    comm_recovery.set_parameter("num_samples", 10)
+
+    # Run commercial recovery analysis
+    comm_recovery.run_analysis()
+```
+
+full analysis: [commercial_building_recovery.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/commercial_building_recovery.ipynb)