Skip to content

Commit

Permalink
Merge pull request #384 from IN-CORE/main
Browse files Browse the repository at this point in the history
Main to dev
  • Loading branch information
longshuicy authored Apr 30, 2024
2 parents 0099945 + b6c6945 commit df50d56
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 12 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ 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]
## [4.11.0] - 2024-04-30

### Changed
- 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

Expand Down
2 changes: 1 addition & 1 deletion manual_jb/content/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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.10.0" # Version is not part of JB config, we use it for autobuild of incore-docs
version: "4.11.0" # Version is not part of JB config, we use it for autobuild of incore-docs
exclude_patterns: [_build, .DS_Store, "**.ipynb_checkpoints"]

repository:
Expand Down
27 changes: 17 additions & 10 deletions manual_jb/content/analyses/populationdislocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` <sup>*</sup> | `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` <sup>*</sup> | `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` <sup>*</sup> | [`ergo:buildingDamageVer4`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer4)<br>[`ergo:buildingDamageVer5`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer5) | Building damage | A building damage dataset.
`housing_unit_allocation` <sup>*</sup> | [`incore:housingUnitAllocation`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:housingUnitAllocation) | Housing allocation | A housing unit allocation dataset.
`block_group_data` <sup>*</sup> | [`incore:blockGroupData`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:blockGroupData) | Block group data | A block group racial distribution dataset.
`value_loss_param` <sup>*</sup> | [`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` <sup>*</sup> | [`ergo:buildingDamageVer4`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer4)<br>[`ergo:buildingDamageVer5`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer5)<br>[`ergo:buildingDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer6)<br>[`ergo:buildingDamageVer7`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer7) | Building damage | A building damage dataset.
`housing_unit_allocation` <sup>*</sup> | [`incore:housingUnitAllocation`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:housingUnitAllocation) | Housing allocation | A housing unit allocation dataset.
`block_group_data` <sup>*</sup> | [`incore:blockGroupData`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:blockGroupData) | Block group data | A block group racial distribution dataset.
`value_loss_param` <sup>*</sup> | [`incore:valueLossParam`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:valueLossParam) | Loss parameters | A table with value loss beta distribution parameters.

**Output Datasets**

Expand Down

0 comments on commit df50d56

Please sign in to comment.