282 update damage analysis documentation for local hazard input (#283)

* add input hazards section for bridge damage
* remove required indicator for input parameters
* update all analyses support hazard object
* changelog entry
* update the verbiage

CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [Unreleased]
+
+### Changed
+- Update damage analysis documentations with hazard object input [#282](https://github.com/IN-CORE/incore-docs/issues/282)
+
 ## [4.6.0] - 2023-10-11
 
 ### Added
@@ -17,7 +22,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### 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

manual_jb/content/analyses/bridge_dmg.md

@@ -18,8 +18,8 @@ The outputs of this analysis are CSV file with probabilities of damage and JSON
 key name | type | name | description
 --- | --- | --- | ---
 `result_name` <sup>*</sup> | `str` | Result name | Name of the result dataset.
-`hazard_type` <sup>*</sup> | `str` | Hazard type | Hazard type (earthquake, tsunami, tornado, hurricaneWindfields). 
-`hazard_id` <sup>*</sup> | `str` | Hazard id | ID of the hazard from the Hazard service. 
+`hazard_type` | `str` | Hazard type | Hazard type (earthquake, tsunami, tornado, hurricaneWindfields). 
+`hazard_id` | `str` | Hazard id | ID of the hazard from the Hazard service. 
 `fragility_key` | `str` | Fragility key | Fragility key used in mapping dataset.
 `use_liquefaction` | `bool` | Liquefaction | Use liquefaction, if applicable to the hazard. <br>Default is *False*.
 `use_hazard_uncertainty` | `bool` | Uncertainty | Use hazard uncertainty.
@@ -33,6 +33,12 @@ key name | type | name | description
 `bridges` <sup>*</sup> | `ergo:bridges` | Bridge dataset | A bridge dataset.
 `dfr3_mapping_set` <sup>*</sup> | `incore:dfr3MappingSet` | DFR3 Mapping Set | DFR3 Mapping Set.
 
+**Input Hazards**
+
+key name | type                                                             | name          | description
+--- |------------------------------------------------------------------|---------------| ---
+`hazard` | `earthquake`<br>`tornado`<br>`hurricane`<br>`flood`<br>`tsunami` | Hazard | Supported hazard object for using local and remote hazards.
+
 **Output datasets**
 
 key name | type | parent key | name | description

manual_jb/content/analyses/epf_dmg.md

@@ -18,15 +18,21 @@ The outputs of this analysis are CSV file with probabilities of damage and JSON
 key name | type | name | description
 --- | --- | --- | ---
 `result_name` <sup>*</sup> | `str` | Result name | Name of the result dataset.
-`hazard_type` <sup>*</sup> | `str` | Hazard type | Hazard type (earthquake, tsunami, tornado, hurricaneWindfields). 
-`hazard_id` <sup>*</sup> | `str` | Hazard id | Hazard ID which defines the particular hazard (e.g. New Madrid <br>earthquake using Atkinson Boore 1995).
+`hazard_type` | `str` | Hazard type | Hazard type (earthquake, tsunami, tornado, hurricaneWindfields). 
+`hazard_id` | `str` | Hazard id | Hazard ID which defines the particular hazard (e.g. New Madrid <br>earthquake using Atkinson Boore 1995).
 `fragility_key` | `str` | Fragility key | Fragility key used in mapping dataset.
 `use_liquefaction` | `bool` | Liquefaction | Use liquefaction, if applicable to the hazard. <br>Default is *False*. Use a ground liquefaction to modify damage interval.
 `liquefaction_fragility_key` | `str` | Liquefaction key | Fragility key to use in liquefaction mapping dataset.
 `liquefaction_geology_dataset_id` | `str` | Liquefaction id | Liquefaction geology/susceptibility dataset id. <br>If not provided, liquefaction will be ignored.
 `use_hazard_uncertainty` | `bool` | Uncertainty | Use hazard uncertainty. <br>Default is *False*.
 `num_cpu` | `int` | Number of CPUs | Number of CPUs used for parallel computations. <br>Default *1*.
 
+**Input Hazards**
+
+key name | type                                                             | name          | description
+--- |------------------------------------------------------------------|---------------| ---
+`hazard` | `earthquake`<br>`tornado`<br>`hurricane`<br>`flood`<br>`tsunami` | Hazard | Supported hazard object for using local and remote hazards.
+
 **Input datasets**
 
 key name | type | name | description
@@ -75,4 +81,4 @@ code snippet:
     epf_dmg.run_analysis()
 ```
 
-full analysis: [epf_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/epf_dmg.ipynb)
+full analysis: [epf_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/epf_dmg.ipynb)

manual_jb/content/analyses/non_structural_building_dmg.md

@@ -22,15 +22,22 @@ with corresponding damage states. The second output file is a JSON with informat
 key name | type | name | description
 --- | --- | --- | ---
 `result_name` <sup>*</sup> | `str` | Result name | Name of the result dataset.
-`hazard_type` <sup>*</sup> | `str` | Hazard type | Hazard type (earthquake).
-`hazard_id` <sup>*</sup> | `str` | Hazard id | ID of the hazard from the Hazard service.
+`hazard_type` | `str` | Hazard type | Hazard type (earthquake).
+`hazard_id` | `str` | Hazard id | ID of the hazard from the Hazard service.
 `fragility_key_as` | `str` | AS fragility | Acceleration-sensitive fragility key used in mapping dataset.
 `fragility_key_ds` | `str` | DS fragility | Drift-sensitive fragility key used in mapping dataset.
 `use_liquefation` | `bool` | Liquefaction | Use liquefaction, if applicable to the hazard. <br>Default *False*.
 `liq_geology_dataset_id` | `str` | Liquefaction id | A liquefaction susceptibility dataset.
 `use_hazard_uncertainty` | `bool` | Uncertainty | Use hazard uncertainty. Default is <br>*False*.
 `num_cpu` | `int` | Number of CPUs | Number of CPUs used for parallel computations. <br>Default *1*.
 
+**Input Hazards**
+
+key name | type          | name          | description
+--- |---------------|---------------| ---
+`hazard` | `earthquake`  | Hazard | Supported hazard object for using local and remote hazards.
+
+
 **Input Datasets**
 
 key name | type | name | description
@@ -82,4 +89,4 @@ code snippet:
     non_structural_building_dmg.run_analysis()
 ```
 
-full analysis: [non_structural_building_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/non_structural_building_dmg.ipynb)
+full analysis: [non_structural_building_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/non_structural_building_dmg.ipynb)

manual_jb/content/analyses/pipeline_dmg.md

@@ -16,13 +16,19 @@ The outputs of this analysis are CSV file with probabilities of damage and JSON
 
 key name | type | name | description
 --- | --- | --- | ---
-`result_name` <sup>*</sup> | `str` | Result name | Name of the result dataset.
-`hazard_type` <sup>*</sup> | `str` | Hazard type (earthquake and tsunami).
+`result_name` | `str` | Result name | Name of the result dataset.
+`hazard_type` | `str` | Hazard type (earthquake and tsunami).
 `hazard_id` <sup>*</sup> | `str` | Hazard id | ID of the hazard from the Hazard service.
 `fragility_key` | `str` | Fragility key | Fragility key used in mapping dataset.
 `liquefaction_geology_dataset_id` | `str` | Geology id | A geology dataset for liquefaction adjustment.
 `num_cpu` | `int` | Number of CPUs | Number of CPUs used for parallel computations. <br>Default *1*.
 
+**Input Hazards**
+
+key name | type | name | description
+--- |---|---| ---
+`hazard` | `earthquake`<br>`tsunami` | Hazard | Supported hazard object for using local and remote hazards.
+
 **Input Datasets** 
 
 key name | type | name | description
@@ -69,4 +75,4 @@ code snippet:
     result = pipeline_dmg.run_analysis()
 ```
 
-full analysis: [pipeline_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/pipeline_dmg.ipynb)
+full analysis: [pipeline_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/pipeline_dmg.ipynb)

manual_jb/content/analyses/pipeline_dmg_w_repair_rate.md

@@ -17,13 +17,19 @@ The outputs of this analysis are CSV file with probabilities of damage and JSON
 key name | type | name | description
 --- | --- | --- | ---
 `result_name` <sup>*</sup> | `str` | Result name | Name of the result dataset.
-`hazard_type` <sup>*</sup> | `str` | Hazard type | Earthquake hazard type.
-`hazard_id` <sup>*</sup> | `str` | Hazard ID | ID of the hazard from the Hazard service.
+`hazard_type` | `str` | Hazard type | Earthquake hazard type.
+`hazard_id` | `str` | Hazard ID | ID of the hazard from the Hazard service.
 `fragility_key` | `str` | Fragility key | Fragility key used in mapping dataset.
 `use_liquefaction` | `bool` | Liquefaction | Use liquefaction, if applicable to the hazard.<br>Default is *False*.
 `liquefaction_fragility_key` | `str` | Liquefaction key | Fragility key used in mapping dataset.
 `num_cpu` | `int` | Number of CPUs | Number of CPUs used for parallel computations.<br>Default *1*.
 
+**Input Hazards**
+
+key name | type | name | description
+--- |---|---| ---
+`hazard` | `earthquake`<br>`tsunami` | Hazard | Supported hazard object for using local and remote hazards.
+
 **Input Datasets**
 
 key name | type | name | description
@@ -72,4 +78,4 @@ code snippet:
     result = pipeline_dmg_w_rr.run_analysis()
 ```
 
-full analysis: [pipeline_dmg_w_repair_rate.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/pipeline_dmg_w_repair_rate.ipynb)
+full analysis: [pipeline_dmg_w_repair_rate.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/pipeline_dmg_w_repair_rate.ipynb)

manual_jb/content/analyses/road_dmg.md

@@ -17,13 +17,19 @@ The outputs of this analysis are CSV file with probabilities of damage and JSON
 key name | type | name | description
 --- | --- | --- | ---
 `result_name` <sup>*</sup> | `str` | Result name | Name of the result dataset.
-`hazard_type` <sup>*</sup> | `str` | Hazard type | Hazard type, earthquake or tsunami.
-`hazard_id` <sup>*</sup> | `str` | Hazard id | ID of the hazard from the Hazard service
+`hazard_type` | `str` | Hazard type | Hazard type, earthquake or tsunami.
+`hazard_id` | `str` | Hazard id | ID of the hazard from the Hazard service
 `fragility_key` | `str` | Fragility key | Fragility key used in mapping dataset.
 `liquefaction_geology_dataset_id` | `str` | Geology id | A geology dataset for liquefaction adjustment.
 `use_hazard_uncertainty` | `bool` | Hazard uncertainty | Use hazard uncertainty.
 `num_cpu` | `int` | Number of CPUs | Number of CPUs used for parallel computations. <br>Default *1*.
 
+**Input Hazards**
+
+key name | type  | name | description
+--- |-------|--------------| ---
+`hazard` | `earthquake`<br>`hurricane`<br>`tsunami` | Hazard | Supported hazard object for using local and remote hazards.
+
 **Input Datasets** 
 
 key name | type | name | description

manual_jb/content/analyses/tornadoepn_dmg.md

@@ -22,7 +22,13 @@ repair cost for each node, total repair cost for the network and total repair ti
 key name | type | name | description
 --- | --- | --- | ---
 `result_name` <sup>*</sup> | `str` | Result name | Name of the result dataset.
-`tornado_id` <sup>*</sup> | `str` | Tornado id | ID of the tornado dataset from the Hazard service.
+`tornado_id` | `str` | Tornado id | ID of the tornado dataset from the Hazard service.
+
+**Input Hazards**
+
+key name | type | name  | description
+--- |-------|--------| ---
+`hazard` | `tornado` | Hazard  | Supported hazard object for using local and remote hazards.
 
 **Input Datasets**
 
@@ -63,4 +69,4 @@ code snippet:
     ted.run_analysis()
 ```
 
-full analysis: [tornadoepn_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/tornadoepn_dmg.ipynb)
+full analysis: [tornadoepn_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/tornadoepn_dmg.ipynb)

manual_jb/content/analyses/waterfacility_dmg.md

@@ -17,15 +17,21 @@ The outputs of this analysis are CSV file with probabilities of damage and JSON
 key name | type | name | description
 --- | --- | --- | ---
 `result_name` <sup>*</sup> | `str` | Result name | Name of the result dataset.
-`hazard_type` <sup>*</sup> | `str` | Hazard type | Hazard type (earthquake and tsunami). 
-`hazard_id` <sup>*</sup> | `str` | Hazard id | ID of the hazard from the Hazard service.
+`hazard_type` | `str` | Hazard type | Hazard type (earthquake and tsunami). 
+`hazard_id` | `str` | Hazard id | ID of the hazard from the Hazard service.
 `fragility_key` | `str` | Fragility key | Fragility key used in mapping dataset.
 `use_liquefaction` | `bool` | Liquefaction | Use liquefaction, if applicable to the hazard. Default is <br>*False*.
 `use_hazard_uncertainty` | `bool` | Uncertainty | Use hazard uncertainty.
 `liquefaction_geology_dataset_id` | `str` | Liquefaction id | Liquefaction susceptibility dataset.
 `liquefaction_fragility_key` | `str` | Fragility key | Fragility key used in mapping dataset.
 `num_cpu` | `int` | Number of CPUs | Number of CPUs used for parallel computations. <br>Default *1*.
 
+**Input Hazards**
+
+key name | type | name | description
+--- |-------|---------------| ---
+`hazard` | `earthquake`<br>`tsunami` | Hazard | Supported hazard object for using local and remote hazards.
+
 **Input Datasets**
 
 key name | type | name | description
@@ -76,4 +82,4 @@ code snippet:
     wf_dmg.run_analysis()
 ```
 
-full analysis: [water_facility_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/water_facility_dmg.ipynb)
+full analysis: [water_facility_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/water_facility_dmg.ipynb)