Skip to content

Commit

Permalink
Merge branch 'develop' into 375-add-libmamba-solver-to-pyincore-insta…
Browse files Browse the repository at this point in the history
…llation-notes
  • Loading branch information
longshuicy authored May 30, 2024
2 parents df62772 + 0453009 commit c1e20dc
Show file tree
Hide file tree
Showing 23 changed files with 1,422 additions and 371 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,20 @@ 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
- Rename Building Portfolio Analysis to Building Cluster Recovery Analysis [#559](https://github.com/IN-CORE/pyincore/issues/559)
- Update flood input to nonstructural damage output for combined wind-wave-surge building damage [#566](https://github.com/IN-CORE/incore-docs/issues/566)
- pyincore, pyincore-viz and pyincore-data installation instructions to include how to use libmamba solver [#375](https://github.com/IN-CORE/incore-docs/issues/375)
- Update docs to reflect Non-structural Building Damage change [#562](https://github.com/IN-CORE/pyincore/issues/562)

### Added
- Gas facility damage analysis documentation and example notebook [#387](https://github.com/IN-CORE/incore-docs/issues/387)
- Traffic flow recovery analysis documentation and example notebook [#389](https://github.com/IN-CORE/incore-docs/issues/389)
- Social vulnerability score analysis documentation and example notebook [#392](https://github.com/IN-CORE/incore-docs/issues/392)
- Google Analytics to the api sphinx documentation [#396](https://github.com/IN-CORE/incore-docs/issues/396)

## [4.11.0] - 2024-04-30

Expand Down
6 changes: 5 additions & 1 deletion manual_jb/content/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ chapters:
- file: analyses
sections:
- file: analyses/bridge_dmg
- file: analyses/building_cluster_recovery
- file: analyses/building_dmg
- file: analyses/building_func
- file: analyses/building_loss
- file: analyses/building_nonstructural_dmg
- file: analyses/capital_shocks
- file: analyses/combined_wind_wave_surge_building_dmg
- file: analyses/combined_wind_wave_surge_building_loss
Expand All @@ -28,6 +30,7 @@ chapters:
- file: analyses/epf_restoration
- file: analyses/epn_functionality
- file: analyses/galveston_cge
- file: analyses/gas_facility_damage
- file: analyses/housing_household_recovery
- file: analyses/housing_recovery
- file: analyses/housingunitallocation
Expand All @@ -38,7 +41,6 @@ chapters:
- file: analyses/mc_failure_prob
- file: analyses/multi_retrofit_optimization
- file: analyses/nci_functionality
- file: analyses/non_structural_building_dmg
- file: analyses/pipeline_dmg
- file: analyses/pipeline_dmg_w_repair_rate
- file: analyses/pipeline_functionality
Expand All @@ -51,7 +53,9 @@ chapters:
- file: analyses/slc_cge
- file: analyses/seaside_cge
- file: analyses/social_vulnerability
- file: analyses/social_vulnerability_score
- file: analyses/tornadoepn_dmg
- file: analyses/traffic_flow_recovery
- file: analyses/transportation_recovery
- file: analyses/waterfacility_dmg
- file: analyses/wfn_functionality
Expand Down
90 changes: 47 additions & 43 deletions manual_jb/content/analyses.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,50 @@
# Analyses

1. [Bridge damage](analyses/bridge_dmg.md)
2. [Building damage](analyses/building_dmg)
3. [Building functionality](analyses/building_func)
4. [Building economic loss](analyses/building_loss)
5. [Capital shocks](analyses/capital_shocks)
6. [Combined wind wave surge building damage](analyses/combined_wind_wave_surge_building_dmg)
7. [Combined wind wave surge building loss](analyses/combined_wind_wave_surge_building_loss)
8. [Commercial building recovery](analyses/commercial_building_recovery)
9. [Cumulative building damage](analyses/cumulative_building_dmg)
10. [Electric power facility damage](analyses/epf_dmg)
11. [Electric power facility repair cost](analyses/epf_repair_cost)
12. [Electric power facility restoration](analyses/epf_restoration)
13. [Electric power network functionality](analyses/epn_functionality)
14. [Galveston Computable General Equilibrium (CGE)](analyses/galveston_cge.md)
15. [Household-level housing sequential recovery](analyses/housing_household_recovery)
16. [Housing recovery](analyses/housing_recovery)
17. [Housing unit allocation](analyses/housingunitallocation)
18. [Interdependent Network Design Problem](analyses/indp)
19. [Joplin Computable General Equilibrium (CGE)](analyses/joplin_cge)
20. [Joplin empirical building restoration](analyses/joplin_empirical_building_restoration)
21. [Machine Learning Enabled Computable General Equilibrium (CGE) - Salt Lake City](analyses/ml_slc_cge.md)
22. [Mean damage](analyses/mean_dmg)
23. [Monte Carlo failure probability](analyses/mc_failure_prob)
24. [Multi-objective retrofit optimization](analyses/multi_retrofit_optimization)
25. [Network cascading interdependency functionality](analyses/nci_functionality)
26. [Nonstructural building damage](analyses/non_structural_building_dmg)
27. [Pipeline damage](analyses/pipeline_dmg)
28. [Pipeline damage with repair rate](analyses/pipeline_dmg_w_repair_rate)
29. [Pipeline functionality](analyses/pipeline_functionality)
30. [Pipeline repair cost](analyses/pipeline_repair_cost)
31. [Pipeline restoration](analyses/pipeline_restoration)
32. [Population dislocation](analyses/populationdislocation)
33. [Portfolio recovery](analyses/portfolio_recovery)
34. [Residential building recovery](analyses/residential_building_recovery)
35. [Road damage](analyses/road_dmg)
36. [Salt Lake City Computable General Equilibrium (CGE)](analyses/slc_cge.md)
37. [Seaside Computable General Equilibrium (CGE)](analyses/seaside_cge)
38. [Social Vulnerability](analyses/social_vulnerability)
39. [Tornado electric power network (EPN) damage](analyses/tornadoepn_dmg)
40. [Transportation recovery](analyses/transportation_recovery)
41. [Water facility damage](analyses/waterfacility_dmg)
42. [Water network functionality](analyses/wfn_functionality)
43. [Water facility repair cost](analyses/water_facility_repair_cost)
44. [Water facility restoration](analyses/water_facility_restoration)
2. [Building cluster recovery](analyses/building_cluster_recovery)
3. [Building damage](analyses/building_dmg)
4. [Building functionality](analyses/building_func)
5. [Building economic loss](analyses/building_loss)
6. [Building nonstructural damage](analyses/building_nonstructural_dmg)
7. [Capital shocks](analyses/capital_shocks)
8. [Combined wind wave surge building damage](analyses/combined_wind_wave_surge_building_dmg)
9. [Combined wind wave surge building loss](analyses/combined_wind_wave_surge_building_loss)
10. [Commercial building recovery](analyses/commercial_building_recovery)
11. [Cumulative building damage](analyses/cumulative_building_dmg)
12. [Electric power facility damage](analyses/epf_dmg)
13. [Electric power facility repair cost](analyses/epf_repair_cost)
14. [Electric power facility restoration](analyses/epf_restoration)
15. [Electric power network functionality](analyses/epn_functionality)
16. [Galveston Computable General Equilibrium (CGE)](analyses/galveston_cge.md)
16. [Gas facility damage](analyses/gas_facility_damage)
17. [Household-level housing sequential recovery](analyses/housing_household_recovery)
18. [Housing recovery](analyses/housing_recovery)
19. [Housing unit allocation](analyses/housingunitallocation)
20. [Interdependent Network Design Problem](analyses/indp)
21. [Joplin Computable General Equilibrium (CGE)](analyses/joplin_cge)
22. [Joplin empirical building restoration](analyses/joplin_empirical_building_restoration)
23. [Machine Learning Enabled Computable General Equilibrium (CGE) - Salt Lake City](analyses/ml_slc_cge.md)
24. [Mean damage](analyses/mean_dmg)
25. [Monte Carlo failure probability](analyses/mc_failure_prob)
26. [Multi-objective retrofit optimization](analyses/multi_retrofit_optimization)
27. [Network cascading interdependency functionality](analyses/nci_functionality)
28. [Nonstructural building damage](analyses/non_structural_building_dmg)
29. [Pipeline damage](analyses/pipeline_dmg)
30. [Pipeline damage with repair rate](analyses/pipeline_dmg_w_repair_rate)
31. [Pipeline functionality](analyses/pipeline_functionality)
32. [Pipeline repair cost](analyses/pipeline_repair_cost)
33. [Pipeline restoration](analyses/pipeline_restoration)
34. [Population dislocation](analyses/populationdislocation)
35. [Residential building recovery](analyses/residential_building_recovery)
36. [Road damage](analyses/road_dmg)
37. [Salt Lake City Computable General Equilibrium (CGE)](analyses/slc_cge.md)
38. [Seaside Computable General Equilibrium (CGE)](analyses/seaside_cge)
39. [Social Vulnerability](analyses/social_vulnerability)
40. [Social Vulnerability Score](analyses/social_vulnerability_score)
41. [Tornado electric power network (EPN) damage](analyses/tornadoepn_dmg)
42. [Traffic flow recovery](analyses/traffic_flow_recovery)
43. [Transportation recovery](analyses/transportation_recovery)
44. [Water facility damage](analyses/waterfacility_dmg)
45. [Water network functionality](analyses/wfn_functionality)
46. [Water facility repair cost](analyses/water_facility_repair_cost)
47. [Water facility restoration](analyses/water_facility_restoration)
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Portfolio recovery
# Building Cluster Recovery

**Description**

The code creates two output files *building-recovery.csv* and *portfolio-recovery.csv*
The code creates two output files *building-recovery.csv* and *cluster-recovery.csv*

**Input Parameters**

Expand All @@ -29,9 +29,9 @@ key name | type | name | description

**Output Datasets**

key name | type | name | description
--- | --- | --- | ---
`result` <sup>*</sup> | [`incore:portfolioRecovery`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:portfolioRecovery) | Results | A dataset containing results (format: CSV).
key name | type | name | description
--- |--------------------------------------------------------------------------------------------------------------| --- | ---
`result` <sup>*</sup> | [`incore:clusterRecovery`](https://incore.ncsa.illinois.<br/>edu/semantics/api/types/incore:clusterRecovery) | Results | A dataset containing results (format: CSV).

<small>(* required)</small>

Expand All @@ -41,25 +41,25 @@ code snippet:

```
# Create instance
bldg_portfolio_recovery = BuildingPortfolioRecoveryAnalysis(client)
bldg_cluster_recovery = BuildingClusterRecovery(client)
# Load input datasets
bldg_portfolio_recovery.load_remote_input_dataset("building_data", bldg_data_dataset)
bldg_portfolio_recovery.load_remote_input_dataset("occupancy_mapping", occupancy_dataset)
bldg_portfolio_recovery.load_remote_input_dataset("building_damage", bldg_damage_dataset)
bldg_portfolio_recovery.load_remote_input_dataset("dmg_ratios", mean_repair_dataset)
bldg_portfolio_recovery.load_remote_input_dataset("utility", utility_dataset)
bldg_portfolio_recovery.load_remote_input_dataset("utility_partial", utility_partial_dataset)
bldg_portfolio_recovery.load_remote_input_dataset("coefFL", coefFL_dataset)
bldg_cluster_recovery.load_remote_input_dataset("building_data", bldg_data_dataset)
bldg_cluster_recovery.load_remote_input_dataset("occupancy_mapping", occupancy_dataset)
bldg_cluster_recovery.load_remote_input_dataset("building_damage", bldg_damage_dataset)
bldg_cluster_recovery.load_remote_input_dataset("dmg_ratios", mean_repair_dataset)
bldg_cluster_recovery.load_remote_input_dataset("utility", utility_dataset)
bldg_cluster_recovery.load_remote_input_dataset("utility_partial", utility_partial_dataset)
bldg_cluster_recovery.load_remote_input_dataset("coefFL", coefFL_dataset)
# Set parameters
bldg_portfolio_recovery.set_parameter("uncertainty", True)
bldg_portfolio_recovery.set_parameter("sample_size", 35) # default none. Gets size form input dataset
bldg_portfolio_recovery.set_parameter("random_sample_size", 50) # default 10000
bldg_portfolio_recovery.set_parameter("no_of_weeks", 100) # default 250
bldg_cluster_recovery.set_parameter("uncertainty", True)
bldg_cluster_recovery.set_parameter("sample_size", 35) # default none. Gets size form input dataset
bldg_cluster_recovery.set_parameter("random_sample_size", 50) # default 10000
bldg_cluster_recovery.set_parameter("no_of_weeks", 100) # default 250
# Creates two output files building-recovery.csv and portfolio-recovery.csv
bldg_portfolio_recovery.run_analysis()
# Creates two output files building-recovery.csv and cluster-recovery.csv
bldg_cluster_recovery.run_analysis()
```

full analysis: [portfolio_recovery.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/portfolio_recovery.ipynb)
full analysis: [building_cluster_recovery.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/building_cluster_recovery.ipynb)
Loading

0 comments on commit c1e20dc

Please sign in to comment.