319 nci functionality analysis accept new input (#323)

* Update nci_functionality.ipynb * Update nci_functionality.md * Update CHANGELOG.md * Update nci_functionality.md * Update nci_functionality.md
IN-CORE · Dec 15, 2023 · a7a701e · a7a701e
1 parent db4e3e7
commit a7a701e
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 55 deletions.
diff --git 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]
+
+### Fixed
+- NCI Functionality analysis accept new input [#319](https://github.com/IN-CORE/incore-docs/issues/319)
+
 ## [4.8.0] - 2023-12-13
 
 ### Added 

diff --git a/manual_jb/content/analyses/nci_functionality.md b/manual_jb/content/analyses/nci_functionality.md
@@ -38,16 +38,17 @@ key name | type | name | description
 
 key name | type | name | description
 --- | --- | --- | ---
-`epf_network` <sup>*</sup> | [`incore:epnNetwork`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:epnNetwork) | Electric Power Facility Network | Electric Power Facility Network Dataset.
-`wds_network` <sup>*</sup> | [`incore:waterNetwork`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:waterNetwork) | Water Distribution Facility Network | Water Distribution Facility Network Dataset.
-`epf_wds_intdp_table` <sup>*</sup> | [`incore:networkInterdependencyTable`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:networkInterdependencyTable) | EPN-to-WDS Interdependency | EPN-to-WDS Interdependency Table.
-`wds_epf_intdp_table` <sup>*</sup> | [`incore:networkInterdependencyTable`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:networkInterdependencyTable) | WDS-to-EPN Interdependency | WDS-to-EPN Interdependency Table.
-`epf_subst_failure_results` <sup>*</sup> | [`incore:failureProbability`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:failureProbability) | Substation failure probability | Substation failure probability Dataset.
-`epf_inventory_rest_map` <sup>*</sup> | [`incore:inventoryRestorationMap`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:inventoryRestorationMap) | EPN inventory restoration map | EPN inventory restoration Map.
-`epf_time_results` <sup>*</sup> | [`incore:epfRestorationTime`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:epfRestorationTime) | EP facility restoration time | EP facility  restoration time Dataset.
-`wds_dmg_results` <sup>*</sup> | [`ergo:waterFacilityDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:waterFacilityDamageVer6) | Water facility damage | Water Facility Damage Dataset.
-`wds_inventory_rest_map` <sup>*</sup> | [`incore:inventoryRestorationMap`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:inventoryRestorationMap) | WDS inventory restoration map | WDS inventory restoration Map.
-`wds_time_results` <sup>*</sup> | [`incore:waterFacilityRestorationTime`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:waterFacilityRestorationTime) | Water facility restoration time | Water facility restoration time Dataset.
+`epf_network` <sup>*</sup> | [`incore:epnNetwork`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:epnNetwork) | Electric Power Facility Network | Electric Power Facility Network Dataset.<br/>`wds_network` <sup>*</sup> | [`incore:waterNetwork`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:waterNetwork) | Water Distribution Facility Network | Water Distribution Facility Network Dataset.
+`epf_wds_intdp_table` <sup>*</sup> | [`incore:networkInterdependencyTable`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:networkInterdependencyTable) | EPN-to-WDS Interdependency          | EPN-to-WDS Interdependency Table.
+`wds_epf_intdp_table` <sup>*</sup> | [`incore:networkInterdependencyTable`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:networkInterdependencyTable) | WDS-to-EPN Interdependency          | WDS-to-EPN Interdependency Table.
+`epf_subst_failure_results` <sup>*</sup> | [`incore:failureProbability`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:failureProbability) | Substation failure probability      | Substation failure probability Dataset.
+`epf_inventory_rest_map` <sup>*</sup> | [`incore:inventoryRestorationMap`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:inventoryRestorationMap) | EPN inventory restoration map       | EPN inventory restoration Map.
+`epf_time_results` <sup>*</sup> | [`incore:epfRestorationTime`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:epfRestorationTime) | EP facility restoration time        | EP facility  restoration time Dataset.
+`wds_dmg_results` <sup>*</sup> | [`ergo:waterFacilityDamageVer6`](https://incore.ncsa.illinois.edu/semantics/api/types/ergo:waterFacilityDamageVer6) | Water facility damage               | Water Facility Damage Dataset.
+`wds_inventory_rest_map` <sup>*</sup> | [`incore:inventoryRestorationMap`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:inventoryRestorationMap) | WDS inventory restoration map       | WDS inventory restoration Map.
+`wds_time_results` <sup>*</sup> | [`incore:waterFacilityRestorationTime`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:waterFacilityRestorationTime) | Water facility restoration time     | Water facility restoration time Dataset.
+`epf_damage` <sup>*</sup> | [`incore:epfDamageVer3`](https://incore.ncsa.illinois.edu/semantics/api/types/incore:epfDamageVer3) | Electric Power Facility Damage      | Electric Power Facility Damage Dataset.
+
 
 **Output datasets** 
 
@@ -77,6 +78,7 @@ code snippet:
     nic_func.set_input_dataset("wds_dmg_results", wds_dmg_results)
     nic_func.set_input_dataset("wds_inventory_rest_map", wds_inventory_rest_map)
     nic_func.set_input_dataset("wds_time_results", wds_time_results)
+    nic_func.set_input_dataset("epf_damage", epf_damage)
 
     # Run Analysis
     nic_func.run_analysis()

diff --git a/notebooks/nci_functionality.ipynb b/notebooks/nci_functionality.ipynb
@@ -22,9 +22,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%%\n"
     }
    },
    "outputs": [],
@@ -64,9 +61,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%% md\n"
     }
    },
    "source": [
@@ -80,9 +74,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%%\n"
     }
    },
    "outputs": [],
@@ -110,9 +101,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%% md\n"
     }
    },
    "source": [
@@ -126,9 +114,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%%\n"
     }
    },
    "outputs": [],
@@ -153,9 +138,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%% md\n"
     }
    },
    "source": [
@@ -169,9 +151,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%%\n"
     }
    },
    "outputs": [],
@@ -199,9 +178,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%% md\n"
     }
    },
    "source": [
@@ -215,9 +191,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%%\n"
     }
    },
    "outputs": [],
@@ -247,9 +220,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%% md\n"
     }
    },
    "source": [
@@ -263,9 +233,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%%\n"
     }
    },
    "outputs": [],
@@ -291,9 +258,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%% md\n"
     }
    },
    "source": [
@@ -307,9 +271,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%%\n"
     }
    },
    "outputs": [],
@@ -327,6 +288,7 @@
     "nci_func.set_input_dataset(\"wds_dmg_results\", wds_dmg_results)\n",
     "nci_func.set_input_dataset(\"wds_inventory_rest_map\", wds_inventory_rest_map)\n",
     "nci_func.set_input_dataset(\"wds_time_results\", wds_time_results)\n",
+    "nci_func.set_input_dataset(\"epf_damage\", substation_dmg_result)\n",
     "nci_func.run_analysis()"
    ]
   },
@@ -336,9 +298,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%% md\n"
     }
    },
    "source": [
@@ -352,9 +311,6 @@
     "collapsed": false,
     "jupyter": {
      "outputs_hidden": false
-    },
-    "pycharm": {
-     "name": "#%%\n"
     }
    },
    "outputs": [],