From d7d7d1ac4c61ee1af461ea96fd2a2b68dd50e624 Mon Sep 17 00:00:00 2001 From: Rashmil Panchani Date: Wed, 24 Apr 2024 11:49:00 -0500 Subject: [PATCH 1/4] rename joplin empirical restoration analysis to joplin empirical building restoration analysis --- ... joplin_empirical_building_restoration.md} | 10 +++++----- manual_jb/content/notebooks_other.md | 2 +- ...plin_empirical_building_restoration.ipynb} | 20 ++++++++++--------- 3 files changed, 17 insertions(+), 15 deletions(-) rename manual_jb/content/analyses/{joplin_empirical_restoration.md => joplin_empirical_building_restoration.md} (90%) rename notebooks/{joplin_empirical_restoration.ipynb => joplin_empirical_building_restoration.ipynb} (92%) diff --git a/manual_jb/content/analyses/joplin_empirical_restoration.md b/manual_jb/content/analyses/joplin_empirical_building_restoration.md similarity index 90% rename from manual_jb/content/analyses/joplin_empirical_restoration.md rename to manual_jb/content/analyses/joplin_empirical_building_restoration.md index 11fd0455..51ff3766 100644 --- a/manual_jb/content/analyses/joplin_empirical_restoration.md +++ b/manual_jb/content/analyses/joplin_empirical_building_restoration.md @@ -1,4 +1,4 @@ -# Joplin empirical restoration model +# Joplin empirical building restoration model **Description** @@ -50,8 +50,8 @@ key name | type | parent key | name | description code snippet: ``` - # Create Joplin empirical restoration analysis instance - restoration = `JoplinEmpiricalRestoration`(client) + # Create Joplin empirical building restoration analysis instance + restoration = `JoplinEmpiricalBuildingRestoration`(client) # Load input dataset restoration.load_remote_input_dataset("buildings", buildings) @@ -65,8 +65,8 @@ code snippet: restoration.set_parameter("target_functionality_level", 0) restoration.set_parameter("seed", 1234) - # Run Joplin empirical restoration analysis + # Run Joplin empirical building restoration analysis restoration.run_analysis() ``` -full analysis: [joplin_empirical_restoration.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_empirical_restoration.ipynb)
+full analysis: [joplin_empirical_building_restoration.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_empirical_building_restoration.ipynb)
diff --git a/manual_jb/content/notebooks_other.md b/manual_jb/content/notebooks_other.md index 969f9c22..e78e349d 100644 --- a/manual_jb/content/notebooks_other.md +++ b/manual_jb/content/notebooks_other.md @@ -25,7 +25,7 @@ Note that some Notebooks might not work with the latest version of pyIncore. [housingunitallocation.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/housingunitallocation.ipynb)
[joplin_cge.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_cge.ipynb)
[joplin_community_app.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_community_app.ipynb)
-[joplin_empirical_restoration.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_empirical_restoration.ipynb)
+[joplin_empirical_building_restoration.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_empirical_building_restoration.ipynb)
[mc_failure_prob.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/mc_failure_prob.ipynb)
[ml_enabled_slc_cge.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/ml_enabled_slc_cge.ipynb)
[mean_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/mean_dmg.ipynb)
diff --git a/notebooks/joplin_empirical_restoration.ipynb b/notebooks/joplin_empirical_building_restoration.ipynb similarity index 92% rename from notebooks/joplin_empirical_restoration.ipynb rename to notebooks/joplin_empirical_building_restoration.ipynb index bed0945f..ed4a0f77 100644 --- a/notebooks/joplin_empirical_restoration.ipynb +++ b/notebooks/joplin_empirical_building_restoration.ipynb @@ -8,7 +8,9 @@ "source": [ "from pyincore import IncoreClient, FragilityService, MappingSet\n", "from pyincore.analyses.buildingdamage import BuildingDamage\n", - "from pyincore.analyses.joplinempiricalrestoration import JoplinEmpiricalRestoration\n", + "from pyincore.analyses.joplinempiricalbuildingrestoration import (\n", + " JoplinEmpiricalBuildingRestoration,\n", + ")\n", "import pyincore.globals as pyglobals" ] }, @@ -25,7 +27,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "### Start with Joplin building damage analysis" + "### Start with Joplin building damage analysis\n" ] }, { @@ -107,14 +109,14 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "### Start with Joplin restoration model" + "### Start with Joplin restoration model\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ - "The example inventory is for Joplin, MO, after 2011 tornado." + "The example inventory is for Joplin, MO, after 2011 tornado.\n" ] }, { @@ -123,7 +125,7 @@ "metadata": {}, "outputs": [], "source": [ - "restoration = JoplinEmpiricalRestoration(client)" + "restoration = JoplinEmpiricalBuildingRestoration(client)" ] }, { @@ -161,8 +163,8 @@ "metadata": {}, "outputs": [], "source": [ - "# Target functionality level is set to FL0, full restoration in the example above. A user has an option \n", - "# to set target functionality level for each building by creating a csv file with two columns; \n", + "# Target functionality level is set to FL0, full restoration in the example above. A user has an option\n", + "# to set target functionality level for each building by creating a csv file with two columns;\n", "# guid of a building and target level from (integer) 0 to 3. The file must be uploaded to IN-CORE data service.\n", "# The dataset id is then used in the notebook:\n", "#\n", @@ -207,9 +209,9 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.8.12" + "version": "3.11.6" } }, "nbformat": 4, "nbformat_minor": 4 -} \ No newline at end of file +} From f5f8f80d033309aae96a41fcba43a098f330ee20 Mon Sep 17 00:00:00 2001 From: Rashmil Panchani Date: Wed, 24 Apr 2024 13:33:36 -0500 Subject: [PATCH 2/4] update analyses.md file --- manual_jb/content/analyses.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manual_jb/content/analyses.md b/manual_jb/content/analyses.md index 624d04f3..ea5c938a 100644 --- a/manual_jb/content/analyses.md +++ b/manual_jb/content/analyses.md @@ -19,7 +19,7 @@ 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 restoration](analyses/joplin_empirical_restoration) +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) From 4a3d206290d8525d7885fcf10fe85c12d1c8785b Mon Sep 17 00:00:00 2001 From: Rashmil Panchani Date: Wed, 24 Apr 2024 13:46:03 -0500 Subject: [PATCH 3/4] missed changes --- .../content/analyses/joplin_empirical_building_restoration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manual_jb/content/analyses/joplin_empirical_building_restoration.md b/manual_jb/content/analyses/joplin_empirical_building_restoration.md index 51ff3766..a4cc0ee3 100644 --- a/manual_jb/content/analyses/joplin_empirical_building_restoration.md +++ b/manual_jb/content/analyses/joplin_empirical_building_restoration.md @@ -58,7 +58,7 @@ code snippet: restoration.load_remote_input_dataset("building_dmg", building_damage) # Specify the result name - result_name = "IN-CORE_Joplin_empirical_restoration" + result_name = "IN-CORE_Joplin_empirical_building_restoration" # Set analysis parameters restoration.set_parameter("result_name", result_name) From 98851bd819a70a056b6e905f72bf6d76cf5cb1ab Mon Sep 17 00:00:00 2001 From: Rashmil Panchani Date: Thu, 25 Apr 2024 14:27:27 -0500 Subject: [PATCH 4/4] add changelog --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cc6f8df9..d2632951 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,11 @@ 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 +- The analysis name from Joplin Empirical Restoration to Joplin Empirical Building Restoration analysis [#367](https://github.com/IN-CORE/incore-docs/issues/367) + ## [4.10.0] - 2024-04-12 ### Added