From cebd43037e7dc523e548e7e43eb4bb86400525ca Mon Sep 17 00:00:00 2001 From: Ya-Lan Yang <63822845+ylyangtw@users.noreply.github.com> Date: Wed, 28 Aug 2024 15:06:01 -0500 Subject: [PATCH] Update INCORE docs according to changes for Interdependent recovery (#422) * update * address feedbacks * update --- CHANGELOG.md | 5 ++++ .../analyses/housing_household_recovery.md | 28 +++++++++++-------- .../analyses/residential_building_recovery.md | 8 ++++-- 3 files changed, 26 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 81cd878b..a7af1d43 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/manual_jb/content/analyses/housing_household_recovery.md b/manual_jb/content/analyses/housing_household_recovery.md index f7261d7d..d792f9b6 100644 --- a/manual_jb/content/analyses/housing_household_recovery.md +++ b/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` * | `str` | Result name | Name of the result dataset. -`seed` * | `int` | Seed | Initial value to seed the random number generator to ensure replication of the Markov Chain path'
in connection with Population Dislocation. -`t_delta` * | `float` | Time step | A size of the analysis time step. -`t_final` * | `float` | Time duration | Total duration. +key name | type | name | description +--- | --- |----------------| --- +`result_name` * | `str` | Result name | Name of the result dataset. +`seed` * | `int` | Seed | Initial value to seed the random number generator to ensure replication of the Markov Chain path'
in connection with Population Dislocation. +`t_delta` * | `float` | Time step | A size of the analysis time step. +`t_final` * | `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` * | [`incore:popDislocation`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:popDislocation) | Population dislocation | Population dislocation results. -`tpm` * | [`incore:houseRecTransitionProbMatrix`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:houseRecTransitionProbMatrix) | Probability matrix | A transition probability matrix that specifies
the corresponding Markov chain per social vulnerability level. -`initial_stage_probability` * | [`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` * | [`incore:popDislocation`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:popDislocation) | Population dislocation | Population dislocation results. +`tpm` * | [`incore:houseRecTransitionProbMatrix`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:houseRecTransitionProbMatrix) | Probability matrix | A transition probability matrix that specifies
the corresponding Markov chain per social vulnerability level. +`initial_stage_probabilities` * | [`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` * | [`incore:housingRecoveryHistory`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:housingRecoveryHistory) | `housing_recovery_block` | Results | A dataset containing results (format: CSV)
with housing recovery sequences at the individual household level. +`ds_result` * | [`incore:housingRecoveryHistory`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:housingRecoveryHistory) | `housing_recovery_block` | Results | A dataset containing results (format: CSV)
with housing recovery sequences at the individual household level. (* required) diff --git a/manual_jb/content/analyses/residential_building_recovery.md b/manual_jb/content/analyses/residential_building_recovery.md index 3c7e4e8f..08dbbc33 100644 --- a/manual_jb/content/analyses/residential_building_recovery.md +++ b/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` * | [`incore:buildingRecovery`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingRecovery) | Results | A dataset containing results (format: CSV)
with percentages of residential building recovery. +key name | type | parent key | name | description +--- | --- | --- |------------------------| --- +`time_stepping_recovery` * | [`incore:buildingRecovery`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingRecovery) | Results | Time Stepping Recovery | A dataset containing results (format: CSV)
with percentages of residential building recovery. +`total_delay` * | [`incore:buildingRecoveryDelay`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingRecovery) | Results | Total Delay | A dataset containing results (format: CSV)
with delay time of residential building recovery. +`recovery` * | [`incore:buildingRecoveryTime`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingRecovery) | Results | Recovery | A dataset containing results (format: CSV)
with delay time of residential building recovery. (* required)