diff --git a/CHANGELOG.md b/CHANGELOG.md index da2cd61b..fceeda2d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - The analysis name from Joplin Empirical Restoration to Joplin Empirical Building Restoration analysis [#367](https://github.com/IN-CORE/incore-docs/issues/367) - Version of Jupyter Book to 0.15.1 [#380](https://github.com/IN-CORE/incore-docs/issues/380) - Replace IN-CORE logo [#377](https://github.com/IN-CORE/incore-docs/issues/377) +- Population dislocation input parameters [#525] (https://github.com/IN-CORE/pyincore/issues/525) ## [4.10.0] - 2024-04-12 diff --git a/manual_jb/content/analyses/populationdislocation.md b/manual_jb/content/analyses/populationdislocation.md index d19b358e..556707b8 100644 --- a/manual_jb/content/analyses/populationdislocation.md +++ b/manual_jb/content/analyses/populationdislocation.md @@ -29,19 +29,26 @@ Retrieved from [hrrc.arch.tamu.edu/publications/research reports/08-05R Dislocat **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. +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. +`choice_dislocation`| `bool` | Choice Dislocation Flag | Flag to calculate choice dislocation. +`choice_dislocation_cutoff`| `float` | Choice Dislocation cutoff | Damage state Probability cutoff for choice dislocation. +`choice_dislocation_ds`| `str` | Choice Dislocation Damage State | Damage state for choice dislocation. +`unsafe_occupancy` | `bool` | Unsafe Occupancy Flag | Flag to calculate unsafe occupancy. +`unsafe_occupancy_cutoff` | `float` | Unsafe Occupancy cutoff | Damage state Probability cutoff for unsafe occupancy. +`unsafe_occupancy_ds` | `str` | Unsafe Occupancy Damage State | Damage state for unsafe occupancy. + **Input Datasets** -key name | type | name | description ---- | --- | --- | --- -`building_dmg` * | [`ergo:buildingDamageVer4`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer4)
[`ergo:buildingDamageVer5`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer5) | Building damage | A building damage dataset. -`housing_unit_allocation` * | [`incore:housingUnitAllocation`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:housingUnitAllocation) | Housing allocation | A housing unit allocation dataset. -`block_group_data` * | [`incore:blockGroupData`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:blockGroupData) | Block group data | A block group racial distribution dataset. -`value_loss_param` * | [`incore:valueLossParam`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:valueLossParam) | Loss parameters | A table with value loss beta distribution parameters. +key name | type | name | description +--- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- | --- +`building_dmg` * | [`ergo:buildingDamageVer4`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer4)
[`ergo:buildingDamageVer5`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer5)
[`ergo:buildingDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer6)
[`ergo:buildingDamageVer7`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer7) | Building damage | A building damage dataset. +`housing_unit_allocation` * | [`incore:housingUnitAllocation`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:housingUnitAllocation) | Housing allocation | A housing unit allocation dataset. +`block_group_data` * | [`incore:blockGroupData`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:blockGroupData) | Block group data | A block group racial distribution dataset. +`value_loss_param` * | [`incore:valueLossParam`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:valueLossParam) | Loss parameters | A table with value loss beta distribution parameters. **Output Datasets**