Added notes to missing notebooks

nasa · Nov 5, 2024 · d5d4b52 · d5d4b52
1 parent 3e1f767
commit d5d4b52
Show file tree

Hide file tree

Showing 12 changed files with 90 additions and 33 deletions.
diff --git a/examples/01_Simulation.ipynb b/examples/01_Simulation.ipynb
@@ -1287,37 +1287,32 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Noise"
+    "## Noise\n",
+    "**A version of this section will be added in release v1.8**"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Vectorized Simulation"
+    "## Vectorized Simulation\n",
+    "**A version of this section will be added in release v1.8**"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "## Configuring Simulation\n",
+    "**A version of this notebook will be added in release v1.8, including:**\n",
     "* t0, x\n",
     "* integration_method"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Conclusions\n",
-    "...\n"
-   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3.11.0 64-bit",
+   "display_name": "Python 3.12.0 64-bit",
    "language": "python",
    "name": "python3"
   },
@@ -1331,12 +1326,12 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.12.0"
   },
   "orig_nbformat": 4,
   "vscode": {
    "interpreter": {
-    "hash": "1a1af0ee75eeea9e2e1ee996c87e7a2b11a0bebd85af04bb136d915cefc0abce"
+    "hash": "aee8b7b246df8f9039afb4144a1f6fd8d2ca17a180786b69acc140d282b71a49"
    }
   }
  },

diff --git a/examples/02_Parameter Estimation.ipynb b/examples/02_Parameter Estimation.ipynb
@@ -491,7 +491,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.12.0"
   },
   "orig_nbformat": 4,
   "vscode": {

diff --git a/examples/03_Existing Models.ipynb b/examples/03_Existing Models.ipynb
@@ -4,15 +4,28 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Using Provided ProgPy Models"
+    "# Using Provided ProgPy Models\n",
+    "\n",
+    "**A version of this notebook will be added in release v1.8**"
    ]
   }
  ],
  "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3.10.7 64-bit",
+   "language": "python",
+   "name": "python3"
+  },
   "language_info": {
-   "name": "python"
+   "name": "python",
+   "version": "3.10.7"
   },
-  "orig_nbformat": 4
+  "orig_nbformat": 4,
+  "vscode": {
+   "interpreter": {
+    "hash": "610c699f0cd8c4f129acd9140687fff6866bed0eb8e82f249fc8848b827b628c"
+   }
+  }
  },
  "nbformat": 4,
  "nbformat_minor": 2

diff --git a/examples/04_New Models.ipynb b/examples/04_New Models.ipynb
@@ -1647,7 +1647,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.6"
+   "version": "3.12.0"
   },
   "orig_nbformat": 4,
   "vscode": {

diff --git a/examples/05_Data Driven.ipynb b/examples/05_Data Driven.ipynb
@@ -4,7 +4,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Using Data-Driven Models"
+    "# Using Data-Driven Models\n",
+    "**A version of this notebook will be added in release v1.8**"
    ]
   }
  ],

diff --git a/examples/06_Combining Models.ipynb b/examples/06_Combining Models.ipynb
@@ -847,7 +847,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.0"
+   "version": "3.12.0"
   },
   "orig_nbformat": 4,
   "vscode": {

diff --git a/examples/07_State Estimation.ipynb b/examples/07_State Estimation.ipynb
@@ -210,6 +210,30 @@
    "source": [
     "With this, we have illustrated how to use a built-in Kalman filter to perform state estimation. Next, we'll show how to create a new, custom state estimator. "
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Unscented Kalman Filter\n",
+    "**A version of this section will be added in release v1.8**"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Particle Filter\n",
+    "**A version of this section will be added in release v1.8**"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Extending\n",
+    "**A version of this section will be added in release v1.8**"
+   ]
   }
  ],
  "metadata": {

diff --git a/examples/08_Prediction.ipynb b/examples/08_Prediction.ipynb
@@ -4,14 +4,16 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 9. Predicting with Prognostics Models"
+    "# 9. Predicting with Prognostics Models\n",
+    "**A full version of this notebook will be added in release v1.8. In the meatime one section has been included below**"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Predicting a specific event"
+    "## Predicting a specific event\n",
+    "**A version of this section will be added in release v1.8**"
    ]
   },
   {
@@ -191,7 +193,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "ProgPyEnvAll",
+   "display_name": "Python 3.11.0 64-bit",
    "language": "python",
    "name": "python3"
   },
@@ -205,9 +207,14 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.6"
+   "version": "3.11.0"
   },
-  "orig_nbformat": 4
+  "orig_nbformat": 4,
+  "vscode": {
+   "interpreter": {
+    "hash": "1a1af0ee75eeea9e2e1ee996c87e7a2b11a0bebd85af04bb136d915cefc0abce"
+   }
+  }
  },
  "nbformat": 4,
  "nbformat_minor": 2

diff --git a/examples/09_Prognostic Example.ipynb b/examples/09_Prognostic Example.ipynb
@@ -4,7 +4,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Integrated Prognostics Example"
+    "# Integrated Prognostics Example\n",
+    "**A version of this notebook will be added in release v1.8**"
    ]
   }
  ],

diff --git a/examples/10_Prognostics Server.ipynb b/examples/10_Prognostics Server.ipynb
@@ -0,0 +1,20 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Prognostics Server (prog_server)\n",
+    "**A version of this notebook will be added in release v1.8**"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  },
+  "orig_nbformat": 4
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/src/progpy/composite_model.py b/src/progpy/composite_model.py
@@ -211,10 +211,10 @@ def __init__(self, models, model_name, key):
                 self.model_name = model_name
                 self.key = key
                 i = 0
-                for (name, m) in models:
+                for (name, _) in models:
                     if name == model_name:
                         break
-                    i+= 1
+                    i += 1
                 self.model_index = i
                 self.combined_key = self.model_name + '.' + self.key
 

diff --git a/tests/test_manual.py b/tests/test_manual.py
@@ -11,7 +11,7 @@
 from unittest.mock import patch
 
 sys.path.append(join(dirname(__file__), ".."))  # Needed to access examples
-from examples import dataset, sim_battery_eol, ensemble, custom_model, playback
+from examples import dataset, sim_battery_eol, custom_model, playback
 
 from progpy.datasets import nasa_cmapss, nasa_battery
 
@@ -84,10 +84,6 @@ def test_sim_battery_eol_example(self):
         with patch('matplotlib.pyplot.show'):
             sim_battery_eol.run_example()
 
-    def test_ensemble_example(self):
-        with patch('matplotlib.pyplot.show'):
-            ensemble.run_example()
-
     def test_custom_model_example(self):
         with patch('matplotlib.pyplot.show'):
             custom_model.run_example()