Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add semantic URL to the dataset types in the analyses md #305

Merged
merged 1 commit into from
Dec 1, 2023
Merged

Add semantic URL to the dataset types in the analyses md #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ 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
- Added semantic data type url linking for the data type in the analyses markdowns [#299](https://github.com/IN-CORE/incore-docs/issues/299)

## [4.7.0] - 2023-11-08

Expand Down
8 changes: 4 additions & 4 deletions manual_jb/content/analyses/bridge_dmg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ key name | type | name | description

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.
`bridges` <sup>*</sup> | [`ergo:bridges`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:bridges) | Bridge dataset | A bridge dataset.
`dfr3_mapping_set` <sup>*</sup> | [`incore:dfr3MappingSet`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:dfr3MappingSet) | DFR3 Mapping Set | DFR3 Mapping Set.

**Input Hazards**

Expand All @@ -43,8 +43,8 @@ key name | type | na

key name | type | parent key | name | description
--- | --- | --- | --- | ---
`result` <sup>*</sup> | `ergo:bridgeDamageVer2` | `bridges` | Results | A dataset containing results <br>(format: CSV).
`damage_result` <sup>*</sup> | `incore:bridgeDamageSupplement` | `bridges` | Results | Information about applied hazard value and fragility<br>(format: JSON).
`result` <sup>*</sup> | [`ergo:bridgeDamageVer2`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:bridgeDamageVer2) | `bridges` | Results | A dataset containing results <br>(format: CSV).
`damage_result` <sup>*</sup> | [`incore:bridgeDamageSupplement`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:bridgeDamageSupplement) | `bridges` | Results | Information about applied hazard value and fragility<br>(format: JSON).

<small>(* required)</small>

Expand Down
10 changes: 5 additions & 5 deletions manual_jb/content/analyses/building_dmg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ key name | type | name | description

key name | type | name | description
--- | --- | --- | ---
`buildings` <sup>*</sup> | `ergo:buildingInventoryVer4`<br>`ergo:buildingInventoryVer5`<br>`ergo:buildingInventoryVer6`<br>`ergo:buildingInventoryVer7` | Building dataset | A building dataset.
`dfr3_mapping_set` <sup>*</sup> | `incore:dfr3MappingSet` | DFR3 Mapping Set | DFR3 Mapping Set.
`retrofit_strategy` | `incore:retrofitStrategy` | Retrofit Strategy | Building retrofit strategy that contains guid and retrofit method.
`buildings` <sup>*</sup> | [`ergo:buildingInventoryVer4`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer4)<br>[`ergo:buildingInventoryVer5`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer5)<br>[`ergo:buildingInventoryVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer6)<br>[`ergo:buildingInventoryVer7`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer7) | Building dataset | A building dataset.
`dfr3_mapping_set` <sup>*</sup> | [`incore:dfr3MappingSet`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:dfr3MappingSet) | DFR3 Mapping Set | DFR3 Mapping Set.
`retrofit_strategy` | [`incore:retrofitStrategy`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:retrofitStrategy) | Retrofit Strategy | Building retrofit strategy that contains guid and retrofit method.

**Output datasets**

key name | type | parent key | name | description
--- | --- | --- | --- | ---
`ds_result` <sup>*</sup> | `ergo:buildingDamageVer5` | `buildings` | Results | A dataset containing results <br>(format: CSV).
`damage_result` <sup>*</sup> | `incore:buildingDamageSupplement` | `buildings` | Results | Information about applied hazard value and fragility<br>(format: JSON).
`ds_result` <sup>*</sup> | [`ergo:buildingDamageVer5`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer5) | `buildings` | Results | A dataset containing results <br>(format: CSV).
`damage_result` <sup>*</sup> | [`incore:buildingDamageSupplement`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingDamageSupplement) | `buildings` | Results | Information about applied hazard value and fragility<br>(format: JSON).

<small>(* required)</small>

Expand Down
12 changes: 6 additions & 6 deletions manual_jb/content/analyses/building_func.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ key name | type | name | description

key name | type | name | description
--- | --- | --- | ---
`building_damage_mcs_samples` <sup>*</sup> | `incore:buildingDamageMcSamples` | Building dataset | Buildings damage dataset.
`substations_damage_mcs_samples` <sup>*</sup> | `incore:substationsDamageMcSamples` | Substation dataset | Substations damage dataset.
`poles_damage_mcs_samples` <sup>*</sup> | `incore:polesDamageMcSamples` | Pole dataset | Electric poles dataset.
`interdependency_dictionary` <sup>*</sup> | `incore:buildingInterdependencyDict` | Interdependency dataset | A dataset of interdependency between buildings and substations and poles.
`building_damage_mcs_samples` <sup>*</sup> | [`incore:buildingDamageMcSamples`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingDamageMcSamples) | Building dataset | Buildings damage dataset.
`substations_damage_mcs_samples` <sup>*</sup> | [`incore:substationsDamageMcSamples`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:substationsDamageMcSamples) | Substation dataset | Substations damage dataset.
`poles_damage_mcs_samples` <sup>*</sup> | [`incore:polesDamageMcSamples`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:polesDamageMcSamples) | Pole dataset | Electric poles dataset.
`interdependency_dictionary` <sup>*</sup> | [`incore:buildingInterdependencyDict`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingInterdependencyDict) | Interdependency dataset | A dataset of interdependency between buildings and substations and poles.

**Output datasets**

key name | type | name | description
--- | --- | --- | ---
`functionality_samples` <sup>*</sup> | `incore:funcSample` | Results | A dataset containing results of functionality samples<br>(format: CSV).
`functionality_probability` <sup>*</sup> | `incore:funcProbability` | Results | A dataset containing results of functionality probability<br>(format: CSV).
`functionality_samples` <sup>*</sup> | [`incore:funcSample`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:funcSample) | Results | A dataset containing results of functionality samples<br>(format: CSV).
`functionality_probability` <sup>*</sup> | [`incore:funcProbability`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:funcProbability) | Results | A dataset containing results of functionality probability<br>(format: CSV).

<small>(* required)</small>

Expand Down
8 changes: 4 additions & 4 deletions manual_jb/content/analyses/building_loss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ key name | type | name | description

key name | type | name | description
--- | --- | --- | ---
`buildings` <sup>*</sup> | `ergo:buildingInventoryVer4`<br>`ergo:buildingInventoryVer5`<br>`ergo:buildingInventoryVer6`<br>`ergo:buildingInventoryVer7` | Building dataset | A building inventory dataset.
`building_mean_dmg` <sup>*</sup> | `ergo:meanDamage`<br>`ergo:buildingDamage` | Building mean damage | A CSV file with building mean damage results for either Structural, Drift-Sensitive Nonstructural, Acceleration-Sensitive Nonstructural or Contents Damage component.
`occupancy_multiplier` | `incore:buildingOccupancyMultiplier` | Occupancy multiplier | Building occupancy damage multipliers. These multipliers account for the value associated with different types of components (structural, acceleration-sensitive nonstructural, drift-sensitive nonstructural, contents).
`buildings` <sup>*</sup> | [`ergo:buildingInventoryVer4`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer4)<br>[`ergo:buildingInventoryVer5`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer5)<br>[`ergo:buildingInventoryVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer6)<br>[`ergo:buildingInventoryVer7`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer7) | Building dataset | A building inventory dataset.
`building_mean_dmg` <sup>*</sup> | [`ergo:meanDamage`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:meanDamage)<br>[`ergo:buildingDamage`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamage) | Building mean damage | A CSV file with building mean damage results for either Structural, Drift-Sensitive Nonstructural, Acceleration-Sensitive Nonstructural or Contents Damage component.
`occupancy_multiplier` | [`incore:buildingOccupancyMultiplier`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingOccupancyMultiplier) | Occupancy multiplier | Building occupancy damage multipliers. These multipliers account for the value associated with different types of components (structural, acceleration-sensitive nonstructural, drift-sensitive nonstructural, contents).

**Output datasets**

key name | type | name | description
--- | --- | --- | ---
`result` <sup>*</sup> | `ergo:buildingEconomicLoss` | Results | A CSV file with building economy losses.
`result` <sup>*</sup> | [`ergo:buildingEconomicLoss`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingEconomicLoss) | Results | A CSV file with building economy losses.

<small>(* required)</small>

Expand Down
8 changes: 4 additions & 4 deletions manual_jb/content/analyses/capital_shocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ key name | type | name | description

key name | type | name | description
--- | --- | --- | ---
`buildings` <sup>*</sup> | `ergo:buildingInventoryVer4`<br>`ergo:buildingInventoryVer5`<br>`ergo:buildingInventoryVer6`<br>`ergo:buildingInventoryVer7` | Building dataset | A building inventory dataset.
`buildings_to_sectors` <sup>*</sup> | `incore:buildingsToSectors` | Buildings to sectors | A file defining sectors of buildings.
`failure_probability` <sup>*</sup> | `incore:failureProbability` | Failure probability | Failure probability of buildings..
`buildings` <sup>*</sup> | [`ergo:buildingInventoryVer4`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer4)<br>[`ergo:buildingInventoryVer5`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer5)<br>[`ergo:buildingInventoryVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer6)<br>[`ergo:buildingInventoryVer7`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer7) | Building dataset | A building inventory dataset.
`buildings_to_sectors` <sup>*</sup> | [`incore:buildingsToSectors`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingsToSectors) | Buildings to sectors | A file defining sectors of buildings.
`failure_probability` <sup>*</sup> | [`incore:failureProbability`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:failureProbability) | Failure probability | Failure probability of buildings..

**Output datasets**

key name | type | name | description
--- | --- | --- | ---
`sector_shocks` <sup>*</sup> | `incore:capitalShocks` | Results | A dataset containing aggregated building functionality to capital shocks<br>(format: CSV).
`sector_shocks` <sup>*</sup> | [`incore:capitalShocks`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:capitalShocks) | Results | A dataset containing aggregated building functionality to capital shocks<br>(format: CSV).

<small>(* required)</small>

Expand Down
10 changes: 5 additions & 5 deletions manual_jb/content/analyses/combined_wind_wave_surge_building_dmg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ key name | type | name | description

key name | type | name | description
--- | --- | --- | ---
`wind_damage` <sup>*</sup> | `ergo:buildingDamageVer6` | Building wind damage | A building wind damage dataset.
`surge_wave_damage` <sup>*</sup> | `ergo:buildingDamageVer6` | Building surge-wave damage | A building surge-wave damage dataset.
`flood_damage` <sup>*</sup> | `ergo:buildingDamageVer6` | Building flood damage | A building flood damage dataset.
`wind_damage` <sup>*</sup> | [`ergo:buildingDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer6) | Building wind damage | A building wind damage dataset.
`surge_wave_damage` <sup>*</sup> | [`ergo:buildingDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer6) | Building surge-wave damage | A building surge-wave damage dataset.
`flood_damage` <sup>*</sup> | [`ergo:buildingDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer6) | Building flood damage | A building flood damage dataset.

**Output datasets**

key name | type | parent key | name| description
--- | --- | --- |---| ---
`result` <sup>*</sup> | `incore:maxDamageState` | `buildings` | Results| A dataset containing maximum damage state for each building<br>(format: CSV).
`ds_result` <sup>*</sup> | `ergo:buildingDamageVer6` | `buildings` | Damage State Results | A dataset containing damage states for building structural damage<br>(format: CSV).
`result` <sup>*</sup> | [`incore:maxDamageState`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:maxDamageState) | `buildings` | Results| A dataset containing maximum damage state for each building<br>(format: CSV).
`ds_result` <sup>*</sup> | [`ergo:buildingDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer6) | `buildings` | Damage State Results | A dataset containing damage states for building structural damage<br>(format: CSV).
<small>(* required)</small>

**Execution**
Expand Down
14 changes: 7 additions & 7 deletions manual_jb/content/analyses/combined_wind_wave_surge_building_loss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ key name | type | name | description

key name | type | name | description
--- | --- |--------------------------------| ---
`buildings` <sup>*</sup> | `ergo:buildingInventoryVer4`<br>`ergo:buildingInventoryVer5`<br>`ergo:buildingInventoryVer6`<br>`ergo:buildingInventoryVer7` | Building dataset | A building dataset.
`wind_damage` <sup>*</sup> | `ergo:buildingDamageVer6` | Building wind damage | A building wind damage dataset.
`surge_wave_damage` <sup>*</sup> | `ergo:buildingDamageVer6` | Building surge-wave damage | A building surge-wave damage dataset.
`flood_damage` <sup>*</sup> | `ergo:buildingDamageVer6` | Building flood damage | A building flood damage dataset.
`structural_cost` <sup>*</sup> | `incore:structuralCostRatio` | Building structural cost ratios | A dataset with building structural cost ratios for each archetype.
`content_cost` <sup>*</sup> | `incore:contentCostRatio` | Building content cost ratios | A dataset with building content cost ratios for each damage state.
`buildings` <sup>*</sup> | [`ergo:buildingInventoryVer4`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer4)<br>[`ergo:buildingInventoryVer5`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer5)<br>[`ergo:buildingInventoryVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer6)<br>[`ergo:buildingInventoryVer7`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingInventoryVer7) | Building dataset | A building dataset.
`wind_damage` <sup>*</sup> | [`ergo:buildingDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer6) | Building wind damage | A building wind damage dataset.
`surge_wave_damage` <sup>*</sup> | [`ergo:buildingDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer6) | Building surge-wave damage | A building surge-wave damage dataset.
`flood_damage` <sup>*</sup> | [`ergo:buildingDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:buildingDamageVer6) | Building flood damage | A building flood damage dataset.
`structural_cost` <sup>*</sup> | [`incore:structuralCostRatio`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:structuralCostRatio) | Building structural cost ratios | A dataset with building structural cost ratios for each archetype.
`content_cost` <sup>*</sup> | [`incore:contentCostRatio`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:contentCostRatio) | Building content cost ratios | A dataset with building content cost ratios for each damage state.

**Output datasets**

key name | type | parent key | name | description
--- | --- | --- |---------| ---
`result` <sup>*</sup> | `incore:buildingLoss` | `buildings` | Results | A dataset containing structural, content and total loss for each building<br>(format: CSV).
`result` <sup>*</sup> | [`incore:buildingLoss`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:buildingLoss) | `buildings` | Results | A dataset containing structural, content and total loss for each building<br>(format: CSV).
<small>(* required)</small>

**Execution**
Expand Down
Loading
Loading