rename joplin empirical restoration analysis to joplin empirical buil…

CHANGELOG.md

@@ -7,7 +7,7 @@ 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)
 - 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)
 

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)

manual_jb/content/analyses/joplin_empirical_restoration.md → manual_jb/content/analyses/joplin_empirical_building_restoration.md

@@ -1,4 +1,4 @@
-# Joplin empirical restoration model
+# Joplin empirical building restoration model
 
 **Description**
 
@@ -50,23 +50,23 @@ 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)
     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)
     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) <br />
+full analysis: [joplin_empirical_building_restoration.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_empirical_building_restoration.ipynb) <br />

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) <br />
 [joplin_cge.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_cge.ipynb) <br />
 [joplin_community_app.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_community_app.ipynb) <br />
-[joplin_empirical_restoration.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_empirical_restoration.ipynb) <br />
+[joplin_empirical_building_restoration.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/joplin_empirical_building_restoration.ipynb) <br />
 [mc_failure_prob.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/mc_failure_prob.ipynb) <br />
 [ml_enabled_slc_cge.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/ml_enabled_slc_cge.ipynb) <br />
 [mean_dmg.ipynb](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/mean_dmg.ipynb) <br />

notebooks/joplin_empirical_restoration.ipynb → 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
-}
+}