Update INCORE docs according to changes for Interdependent recovery (#…

…422)

* update

* address feedbacks

* update

CHANGELOG.md

@@ -4,6 +4,11 @@ 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/).
 
+## Unreleased
+
+### Changed
+- Update docs according to support Interdependent recovery analysis [#417](https://github.com/IN-CORE/incore-docs/issues/417)
+
 ## [4.13.0] - 2024-08-21
 
 ### Changed

manual_jb/content/analyses/housing_household_recovery.md

@@ -23,26 +23,30 @@ The output of the computation is the history of housing recovery changes for eac
 
 **Input parameters**
 
-key name | type | name | description
---- | --- | --- | ---
-`result_name` <sup>*</sup> | `str` | Result name | Name of the result dataset.
-`seed` <sup>*</sup> | `int` | Seed | Initial value to seed the random number generator to ensure replication of the Markov Chain path'<br>in connection with Population Dislocation.
-`t_delta` <sup>*</sup> | `float` | Time step | A size of the analysis time step.
-`t_final` <sup>*</sup> | `float` | Time duration | Total duration.
+key name | type | name           | description
+--- | --- |----------------| ---
+`result_name` <sup>*</sup> | `str` | Result name    | Name of the result dataset.
+`seed` <sup>*</sup> | `int` | Seed           | Initial value to seed the random number generator to ensure replication of the Markov Chain path'<br>in connection with Population Dislocation.
+`t_delta` <sup>*</sup> | `float` | Time step      | A size of the analysis time step.
+`t_final` <sup>*</sup> | `float` | Time duration  | Total duration.
+`num_cpu` | `int` | Number of CPUs | If using parallel execution, the number of cpus to request.
 
 **Input datasets**
 
-key name | type | name | description
---- | --- | --- | ---
-`population_dislocation_block` <sup>*</sup> | [`incore:popDislocation`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:popDislocation) | Population dislocation | Population dislocation results.
-`tpm` <sup>*</sup> | [`incore:houseRecTransitionProbMatrix`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:houseRecTransitionProbMatrix) | Probability matrix | A transition probability matrix that specifies<br>the corresponding Markov chain per social vulnerability level.
-`initial_stage_probability` <sup>*</sup> | [`incore:houseRecInitialStageFactors`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:houseRecInitialStageFactors) | Mass probability | Initial mass probability function for stage 0 of the Markov Chain.
+key name | type | name                        | description
+--- | --- |-----------------------------| ---
+`population_dislocation_block` <sup>*</sup> | [`incore:popDislocation`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:popDislocation) | Population dislocation      | Population dislocation results.
+`tpm` <sup>*</sup> | [`incore:houseRecTransitionProbMatrix`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:houseRecTransitionProbMatrix) | Probability matrix          | A transition probability matrix that specifies<br>the corresponding Markov chain per social vulnerability level.
+`initial_stage_probabilities` <sup>*</sup> | [`incore:houseRecInitialStageFactors`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:houseRecInitialStageFactors) | Mass probability            | Initial mass probability function for stage 0 of the Markov Chain.
+`sv_result` | [`incore:socialVulnerabilityScore`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:popDislocation) | Social vulnerability result | A csv file with zones containing demographic factors.
+`zone_def_sv` | [`incore:zoneDefinitionsSocialVulnerability`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:houseRecTransitionProbMatrix) | Zone Definition: social vulnerability           | A json file with thresholds and definitions per zone based on social vulnerability analysis.
+`zone_def_hhinc` | [`incore:zoneDefinitionsHouseholdIncome`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:houseRecInitialStageFactors) | Zone Definition: household income           | A json file with thresholds and definitions per zone based on household income.
 
 **Output datasets**
 
 key name | type | parent key | name | description
 --- | --- | --- | --- | ---
-`result` <sup>*</sup> | [`incore:housingRecoveryHistory`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:housingRecoveryHistory) | `housing_recovery_block` | Results | A dataset containing results (format: CSV)<br>with housing recovery sequences at the individual household level.
+`ds_result` <sup>*</sup> | [`incore:housingRecoveryHistory`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:housingRecoveryHistory) | `housing_recovery_block` | Results | A dataset containing results (format: CSV)<br>with housing recovery sequences at the individual household level.
 
 <small>(* required)</small>
 

manual_jb/content/analyses/residential_building_recovery.md

@@ -47,9 +47,11 @@ key name | type | name | description
 
 **Output datasets**
 
-key name | type | parent key | name | description
---- | --- | --- | --- | ---
-`residential_building_recovery` <sup>*</sup> | [`incore:buildingRecovery`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingRecovery) | Results | A dataset containing results (format: CSV)<br>with percentages of residential building recovery.
+key name | type | parent key | name                   | description
+--- | --- | --- |------------------------| ---
+`time_stepping_recovery` <sup>*</sup> | [`incore:buildingRecovery`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingRecovery) | Results | Time Stepping Recovery | A dataset containing results (format: CSV)<br>with percentages of residential building recovery.
+`total_delay` <sup>*</sup> | [`incore:buildingRecoveryDelay`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingRecovery) | Results | Total Delay            | A dataset containing results (format: CSV)<br>with delay time of residential building recovery. 
+`recovery` <sup>*</sup> | [`incore:buildingRecoveryTime`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingRecovery) | Results | Recovery               | A dataset containing results (format: CSV)<br>with delay time of residential building recovery. 
 
 <small>(* required)</small>