CHANGELOG.md

Change Log

All notable changes to the INCORE documents generated by Sphinx package will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

Changed

• Update damage analysis documentations with hazard object input #282
• Building Portfolio Recovery analysis notebook 286

Fixed

• The notebook create_network_dataset.ipynb fails on nx.info #284

[4.6.0] - 2023-10-11

Added

• Added commercial buildings markdown and notebook #271
• Local hazard tutorial #272

Fixed

• Broken notebook using restoration util class #260

Changed

• Add additional input dataset and citation to INDP #274

[4.5.0] - 2023-08-16

Added

• Interdependent Network Design Problem (INDP) #250

Fixed

• Broken tornado visualization in pyincore-viz example notebook #254

Changed

• Upgrade swagger ui to 5.3.1 and use auto generated openapi json #253

[4.2.0] - 2023-06-14

Added

• Add query parameter "sort" and "orderBy" to swagger docs for selected endpoints #240
• Add documentation and notebook for electric power facility repair cost analysis #242
• Add documentation and notebook for water facility repair cost analysis #245
• Add documentation and notebook for water pipeline repair cost analysis #244

[4.1.0] - 2023-04-24

Added

• Galveston community app example notebook #196
• location to create earthquake notebook that give hazard output for the dataset example #221
• Galveston Island CGE #202

Changed

• Added another variable to fix unpacking error #234
• Modified the faliure state keys for slc community app notebook #226
• Removed old functionality code from slc community app notebook #232

[4.0.0] - 2023-03-15

Added

• Salt Lake City CGE #190
• New endpoint for getting space by space name in API #203
• Combined building wind, wave, surge loss analysis documentation and example notebook #205
• Salt Lake City community app example notebook #187

Changed

• Updated Housing Household Recovery notebook to use new CensusUtil functions #269
• Updated pyincore-data example with new census util #183
• Remove incorrect characterization of population dislocation dataset 185
• Update combined damage analysis documentation #194
• Updated Housing Household Recovery notebook to use new CensusUtil functions #269
• Updated pyincore-data example notebook with census utils blockgroup dislocation #213
• Lumberton testbed notebook updated with new pyincore-data update #211

Fixed

• Joplin retrofit plan example notebook to use public space hazards #175
• Remove broken images from mmsa notebook 156
• Typo in Lumberton testbed notebook 189
• Removed testbed name from CGE data type #265
• Add paramter seed to MCS documentation #208

[3.7.0] - 2022-11-16

Added

• Explanation about fiona related problem in pyincore installation documentation #176

Changed

• Bridge damage analysis documentation to include new parameter for using liquefaction in damage calculation #178

[3.6.0] - 2022-09-14

Added

• Include Galveston Hurricane EPF damage example #153
• Gdf map overlay with raster hazard added to pyincore-viz example notebook #105.
• Network cascading interdependency functionality #167
• Combined wind, wave and surge analysis documentation and example #154

Changed

• Updated analysis specifications with new nested types specification #164
• Updated branch name in links #137.
• Updated pyincore installation instructions with the version information #122.
• Swagger API for services 1.11.0 #159.

Fixed

• Multiple vector visualization using the tornado dataset #106.
• Some example notebooks were not displaying output #155.
• Missing MMSA testbed links #170.

[3.5.0] - 2022-07-27

Added

• Electric power network functionality #138.
• Water facility network functionality #139.
• MMSA seismic functionality analysis for interdependent buildings-water-power using fragility and repair rate curves #142.
• Example notebook for creating a network dataset #88.
• Pipeline functionality and example notebook #131.

Changed

• Update network dataset visualization in pyincore-viz example notebook #118.
• Update housing recovery notebook to use csv format of appraisal dataset #121.
• Modify social vulnerability to query census data from CensusUtil instead of stored datasets #107.
• Update housing recovery sequential notebook to use output of social vulnerability analysis #129.
• Updated epf and wf restoration analysis documentation for new input and output #143.
• Updated electric power facility restoration notebook to use epf damage and output discretized restoration #127.
• Updated water facility restoration notebook to use water facility damage and output discretized restoration #128.

Fixed

• Building economic loss example notebook had null output #123.

[3.2.0] - 2022-06-29

Changed

• Building damage example notebook with liquefaction #109
• Tornado EPN damage notebook refactored based on new network dataset #111.
• Swagger jsons for services 1.10.0 #110.

Fixed

• pyincore-viz example notebook broken hazard id and temporarily removed network dataset example #115

[3.1.0] - 2022-03-30

Added

• Toro1997 earthquake to supported models #78.
• Housing recovery analysis #85.
• Social vulnerability analysis #94.

Changed

• Renamed master branch to main #80.
• Remove manual from repository #82.
• Clean testbed notebooks, update requirements, change loss parameter #86.
• Swagger jsons for services 1.9.0

Fixed

• Update the Jupyter notebooks for epf and wf restorations #89.
• Value loss param typo #91.

[3.0.0] - 2022-02-07

Added

• Multiple dataset visualization for vector based dataset #54.
• Water facility restoration model documentation #55.
• Lifeline workshop files #63.
• Electric power facility restoration documentation #70.

Changed

• Building loss example notebook to demonstrate building economic loss for structural and non structural damage #44.
• Jupyter Book with new theme #47.
• DFR3 visualization in pyincore-viz-example updated based on new dfr3 visualization #60.
• GitHub action to build jupyter book #67.
• Galveston notebook with updated dfr3 visualization #71.
• Swagger jsons for services 1.8.0

Fixed

• Content in Jupyter Book, links, typos #58.

[2.8.0] - 2021-12-15

Added

• Video link to Workshop presentation. #4.
• Multi-objective retrofit optimization model documentations #17.
• Joplin empirical restoration analysis final state dataset #30.
• WIP: Documentation in Jupyter Book format #31.
• Retrofit notebook to tutorial/examples #35.

Changed

• HUA and PD contributors and description #29.
• Electric power facility damage specification related to liquefaction #36.
• Swagger jsons for services 1.7.0

[2.7.0] - 2021-10-27

Added

• Automatic documentation container build and publish INCORE1-1349.
• Prerequisit section to Lumberton and Galveston notebooks #2.
• Joplin Empirical Restoration model analysis #3.
• Choropleth map using single dataset with multiple field in pyincore-viz example notebook. #11.
• Choropleth map using multiple datasets in pyincore-viz example notebook. #12.

Changed

• pyIncore installation instructions #1
• Pyincore-viz analysis viz example notebook. #7
• Parameters for excluding hazard dataset in the service in api. #18
• Upgrade guide page #23.
• Dfr3 tutorial json and notebook #24.
• Swagger jsons for services 1.6.0

[2.6.0] - 2021-09-01

Added

• Myst parser for md rendering INCORE1-1207.
• Wokshop presentation No.2 INCORE1-1392.

Changed

• Data type of Sector shocks in Seaside CGE INCORE1-1389.
• Swagger jsons for services 1.5.0

[2.5.1] - 2021-08-04

Changed

• Deprecated methods were updated in Lumberton testbed notebook INCORE1-1328.

Fixed

• Panda's DataFrame copy warnings in Lumberton notebook INCORE1-1332.

[2.5.0] - 2021-07-28

Added

• Road failure example to road damage notebook INCORE1-1263.
• Residential building recovery analysis documentation INCORE1-1277.
• Household-level housing sequential recovery analysis documentation INCORE1-1278.
• pyIncore_data example notebook INCORE1-1286.
• Lumberton testbed jupyter notebook INCORE1-1295.
• Link to pyIncore_data INCORE1-1300.

Changed

• Hazard tutorials use POST values INCORE1-1206.
• New fragility curve format for creating DFR3 object notebook INCORE1-1262.
• Swagger jsons for services 1.4.0

[2.3.0] - 2021-06-16

Added

• Workshop files and notebooks INCORE1-1217.
• plot raster dataset in pyincore-viz example notebook INCORE1-1223.

Changed

• python 3.8 and sphinx libriries INCORE1-1219.
• Galveston testbed notebook updated with new raster visualization method INCORE1-1237.
• Updated specs for building and road damage INCORE1-1234.
• Removed road failure analysis INCORE1-1234.

[2.2.1] - 2021-05-25

Added

• Terms of Service INCORE1-1194.
• Docker release script INCORE1-1197.

[2.2.0] - 2021-05-19

Added

• Heatmap for HUA to Galvenston testbed notebook INCORE1-1127.
• Examples to visualize refactored (equation) based 2d and 3d fragility curves INCORE1-1144.

Changed

• Swagger version update for services v1.2.0
• Python version requirement (3.6-3.8) in prerequisites and faq INCORE1-1161.
• Output datasets description related to pipeline, road, epn tornado, water damages, road failure and pipeline repair rate spit outputs INCORE1-1170.
• Output datasets description and notebooks related to non-structural building damage output split INCORE1-1171.
• Damage key names in water facility, mean, mc failure and building functionality notebooks INCORE1-1191.

Fixed

• Tornado windfield type in EPN analysis documentation. INCORE1-1135.
• Where ipopt command in Joplin notebook and both, Seaside and Joplin CGE example notebooks INCORE1-1158.

[2.1.1] - 2021-04-21

Added

• Galveston bridge damage example in bridge damage example jupyter notebook INCORE1-1117

[2.1.0] - 2021-04-14

Added

• Methods in pyincore-viz example notebook for visualization of heat maps INCORE1-1097.

Changed

• Swagger version update for services v1.1.0
• Remove local files, update prerequisites, visualize maps INCORE1-1072.

Fixed

• Jira links in Changelog INCORE1-1068.

[2.0.2] - 2021-03-12

Fixed

• Delete output cells in HUA example notebook INCORE1-1041.
• Galveston notebook population dislocation chaining INCORE1-1043.

[2.0.1] - 2021-03-01

Fixed

• Dataset id in seaside_cge.ipynb INCORE1-1025.
• Dataset type in mean_dmg.ipynb INCORE1-1025.
• Datasets in cumulative_building_dmg.ipynb, linked with inventory damages INCORE1-1025.
• Type in transportation_recovery.ipynb INCORE1-1025.
• Dataset id in tornadoepn_dmg.ipynb INCORE1-1025.
• Result dataset type in Getting started tutorial INCORE1-1025.
• Create dataset tutorial INCORE1-1022.
• Links to Lab INCORE1-1024.
• Failing fragility in create_dfr3 object tutorial INCORE1-1021.
• Updated output cells of Galveston Testbed INCORE1-1026.

[2.0.0] - 2021-02-28

Added

• Galveston testbed notebook INCORE1-988.
• Multi format visualization method in pyincore-viz example notebook INCORE1-843.

Changed

• Update analyses and example notebooks reflecting new damage state definition INCORE1-971.
• Update Seaside testbed notebooks reflecting new damage state definition INCORE1-972.
• Update Joplin testbed notebooks reflecting new damage state definition INCORE1-993.

Fixed

[1.8.0] - 2020-12-18

Added

• Galveston example notebook to Housing Unit Allocation analysis INCORE1-886.

Changed

• Visual outputs in Seaside and Joplin testbed notebooks INCORE1-780.

Fixed

• Typos in analyses descriptions and correct the dataset type in Population dislocation INCORE1-777.

[1.7.0] - 2020-10-28

Added

• building economic loss analysis documentation and notebook INCORE1-771.
• Seaside testbed notebook to have dataset list mapping INCORE1-788.
• after visualization from local or from url added to pyincore-viz example notebook INCORE1-798.
• fragility visualization to Joplin testbed notebook INCORE1-791.
• raster visualization in pyincore-viz example notebook INCORE1-798.

Changed

• aggregate and visualize building functionality results in Joplin testbed notebook INCORE1-739.
• Joplin testbed notebook modified to update CGE analysis outputs INCORE1-779.
• Seaside testbed notebook modified to have chain of analysis INCORE1-787.
• CGE analysis documentation and notebook INCORE1-802.

Fixed

• raster file used in dataset based equation in tutorial INCORE1-785.

[1.6.0] - 2020-09-04

Added

• tutorials to create earthquakes & tornadoes INCORE1-741.
• pyincore-viz-example notebook INCORE1-749.
• network dataset visualization in pyincore-viz-example notebook INCORE1-752.

Changed

• replace Fragility terms with DFR3 INCORE1-701.
• expand description, add link to the notebook. INCORE1-736.
• update building functionality analysis outputs and notebook INCORE1-737.
• move testbed zip files to Notebooks. INCORE1-738.
• swagger specs for services v0.8.0 INCORE1-760

[1.5.0] - 2020-07-31

Added

• tutorial, create and use Dataset object INCORE1-558
• faq update section INCORE1-575.
• tutorial, create and use dfr3 object INCORE1-648.
• upgrade guide for pyIncore INCORE1-692.
• building functionality notebook INCORE1-702.
• notebook for road damage analysis for hurricane inundation INCORE1-705.
• road failure page and notebook INCORE1-710.
• hurricane endpoints of Galveston model to swagger specs INCORE1-726.

Changed

• list of hazards in analyses' description, updated epf types INCORE1-684.
• chaining of Building damage with other analyses INCORE1-693.
• MC failure analysis notebook INCORE1-702.

Fixed

• broken links to account page, dfr3 viewer etc. INCORE1-687.

[1.4.5] - 2020-06-30

Added

• add road damage notebook INCORE1-608.

Changed

• change dfr3 format notebooks, change names of some notebooks INCORE1-608.
• change dfr3 format; analyses input and parameter description, code snippets INCORE1-607.
• Swagger specs for services 0.6.7

[1.4.1] - 2020-06-16

Changed

• Swagger specs for services 0.6.6

[1.4.0] - 2020-06-01

Added

• Tutorials and tips, document structure INCORE1-377.
• Quick pyIncore installation reference, INCORE1-622.
• Semantics endpoints to swagger 0.6.5.
• More about Anaconda installation INCORE1-566.
• Update notebooks and Building damage specifications INCORE1-607.
• Improve pyincore chapter INCORE1-543.

Changed

• Update House unit allocation notebook INCORE1-634.

Fixed

• Clean notebooks, delete outputs INCORE1-641.
• Link to Joplin notebook page from intro INCORE1-634.

[1.3.1] - 2020-04-27

Fixed

• Hot fixes in pyincore-0.6.2 and web-0.4.3.

[1.3.0] - 2020-03-31

Added

• Getting started page INCORE1-441.
• More FAQ questions INCORE1-376.

Changed

• NCSA account link.

[1.2.0] - 2020-03-02

Added

• Swagger specifications for v0.6.3

Changed.

• Docker script.

[1.1.0] - 2020-02-14

Added

• Building functionality description (buildingfunctionality.md).
• pyIncore_viz installation instructions

Changed.

• Removed notebook installation from Prerequisites.

Fixed oh OK so it has three parts they didn't change and whatever OK the same thing edit fixed and changed

• Broken links to GitHub notebooks

[1.0.0] - 2019-12-17

[0.5.2] - 2019-11-27

Added

• Resolved comments from the CoE.
• New structure of analyses.md, split into individual files.
• more FAQ.

Changed.

• Folder structure.

Fixed

• Typos, errors