Added place for architecture figure

nasa · Oct 10, 2024 · dada677 · dada677
1 parent 21bce32
commit dada677
Showing 1 changed file with 20 additions and 4 deletions.
diff --git a/examples/2024PHMTutorial.ipynb b/examples/2024PHMTutorial.ipynb
@@ -57,7 +57,7 @@
    "source": [
     "NASA’s ProgPy is an open-source python package supporting research and development of prognostics, health management, and predictive maintenance tools. It implements architectures and common functionality of prognostics, supporting researchers and practitioners.\n",
     "\n",
-    "The goal of this tutorial is to instruct users to use and extend ProgPy. This tutorial will cover how to use a model, including existing models and additional capabilities like parameter estimation and simulation, as well as how to build a new model from scratch. "
+    "The goal of this tutorial is to instruct users how to use and extend ProgPy. This tutorial will cover how to use a model, including existing models and additional capabilities like parameter estimation and simulation, as well as how to build a new model from scratch. "
    ]
   },
   {
@@ -96,7 +96,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "_Prognostics Model_ \n",
+    "_Prognostics Models_ \n",
     "\n",
     "The Prognostics Models are the backbone of the ProgPy architecture. Models describe the specific system that prognostics will be applied to and how the system will evolve with time. Everything else within ProgPy (e.g. simulation capabiliites and prognostics tools) are built on top of a model. \n",
     "\n",
@@ -124,6 +124,18 @@
     "* **States**: Internal parameters (typically hidden states) used to represent the state of the system- can be same as inputs/outputs but do not have to be."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "These all come together to create the prognostic architecture of ProgPy, illustrated below. \n",
+    "\n",
+    "<span style=\"color:red\">\n",
+    "Include image here ... maybe this one? https://nasa.github.io/progpy/guide.html#:~:text=In%20general%2C%20the%20ProgPy%20prognostic%20approach%20is%20illustrated%20below. \n",
+    "or this one: https://nasa.github.io/progpy/prog_models_guide.html#modeling-and-sim-guide:~:text=derivative%20enables%20some-,approaches,-that%20rely%20on\n",
+    "<\\span>"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -135,12 +147,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "<span style=\"color:red\">\n",
     "•\tIntroduce- existing models, data driven tools\n",
     "•\tBattery Model – Electrochemistry EOD\n",
     "•\tSet parameters using data\n",
     "•\tSimulate \n",
     "•\tSetup an example with prognostics & data\n",
-    "•\tSurrogate model – build surrogate model, compare runtime\n"
+    "•\tSurrogate model – build surrogate model, compare runtime\n",
+    "</span>\n"
    ]
   },
   {
@@ -154,7 +168,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Physics-based model - gina's paper https://pdf.sciencedirectassets.com/271430/1-s2.0-S0951832018X00118/1-s2.0-S0951832018301406/main.pdf?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEOf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIQDHUQko0e0m4%2FlIldnWu1lDZbayIk67ocTDehGjZgP6FgIgD55xPb3jLS6K8EyX3s1lSX%2BnVvLlsIIa9TIIy%2Buwl28qswUIMBAFGgwwNTkwMDM1NDY4NjUiDJfJkp1G%2BseYmZbkWiqQBWS02f6iSlTb6E5xApTaglevAKKgVJzivsafjmt5vOr9Z6uhi7ZlP7zU2NGuDZ2Gw5Lgqjt3UKOylT479Rz7%2BA5oOKEt6Ru23Gnga2yiTEZGbcH3SAyoSPrFsQtLjzrhsUssIT2KPV5KjSinVH30vjQuFSUy5iHNU1onYVMLZWcDcK3%2BL%2B0luS%2BwKtBA0tt11VEzzFgoWt7vgJbG8ue40aW3d6nNZCzF84uGZND47ncFPZWpxGXDIjxgS9rrcyDmsgyetu7LD6rw%2BqkwdfW1AUBfG4a5Yhuvvu1QtV3QE3OKch4CbdKDoYdYYYefCpLNM%2BexJjMV2AIRqfBTPAnx%2FZdzMHBVuVVEPfDqrN%2B8wG6zjderc%2B1W9jEzQqq6YLbxZwrmBpYrzNEzEtxu13MWs0JehvpzGnkYKInBS7jJtS3tkZdNAAMGU8jiHXot1x8YC4GQhbcXuK3q9SxRdNed2gAtw6135nugN8%2BeNiRsVhYO5HBWlHCuXBmGqsJp9e6tzwF8fohi54YZfxZPYM0IyVE6Eg1ulgfnEZ3rAZDTPzGmpCu8FqoDcH55pJlf83spnhkPDuUYkE4IBPscCNnoxYQOff41bmLjRw7qGoJizj%2B%2BQ23mIOTdZrEemf947SuBZzUV9O3J0f%2BscDeGBH1GQXtuTI3n0bkbXaJckhbRj1MdGDujCeGCThw8f3uHfrrvail9zYlV%2F3wvwbC%2Bl1CR3zmf614bdcLQeFlHZl1T9teRLmSwGG%2BF4eYt9tsJQzOvBZnUJQXAbEcmaqq%2FscuaRpqgREtzbV1vcZkbDuTrykI5K917BYzi1K5rP7ziSuY%2B0EPRMtnkF6zyENi2gUw5zEuMIeMbahUGsXGDKh2RmHsIMNeL27cGOrEBv%2BJFeclfM98ADu0afkjh6ZFekuPSXbpitqyuULpKQr1d%2BU%2FD4r%2B5Kp892hLBABccRe%2BUbMi2ARRPZTArRF4nIxC0R1otNzM2aD4Tb0FY2WAUvsPaeroAXxqcTNKOjkeQ7AOhW24XvrawwpHfYXYbocaRJnTOSCJgVFWgEd2eIx4cki8V83w%2BBXJ4DACtZb5OohBleG8YTRxgWU4lTLs4unC9rGu6my8eUgZIJ3gpiS22&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240927T162404Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Credential=ASIAQ3PHCVTYZSOCUIYN%2F20240927%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=fbf4aeb21d15feeebb3b858e8cfc06fea3f5fa46f65a126db27aa5a42581abe1&hash=9409fab9678a5e5e71fffe1b9e0e8af84f7319fc89f11a26cbe43b4a7af3fc84&host=68042c943591013ac2b2430a89b270f6af2c76d8dfd086a07176afe7c76c2c61&pii=S0951832018301406&tid=spdf-8e0342b3-e68a-4672-b2e0-c0c32c99d50d&sid=73f323dd40c6e842628bdea3793ab7c0f495gxrqa&type=client&tsoh=d3d3LnNjaWVuY2VkaXJlY3QuY29t&ua=0f1559055b0604515c5d52&rr=8c9cd7835f27fa72&cc=us"
+    "<span style=\"color:red\">\n",
+    "Physics-based model - gina's paper https://pdf.sciencedirectassets.com/271430/1-s2.0-S0951832018X00118/1-s2.0-S0951832018301406/main.pdf?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEOf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIQDHUQko0e0m4%2FlIldnWu1lDZbayIk67ocTDehGjZgP6FgIgD55xPb3jLS6K8EyX3s1lSX%2BnVvLlsIIa9TIIy%2Buwl28qswUIMBAFGgwwNTkwMDM1NDY4NjUiDJfJkp1G%2BseYmZbkWiqQBWS02f6iSlTb6E5xApTaglevAKKgVJzivsafjmt5vOr9Z6uhi7ZlP7zU2NGuDZ2Gw5Lgqjt3UKOylT479Rz7%2BA5oOKEt6Ru23Gnga2yiTEZGbcH3SAyoSPrFsQtLjzrhsUssIT2KPV5KjSinVH30vjQuFSUy5iHNU1onYVMLZWcDcK3%2BL%2B0luS%2BwKtBA0tt11VEzzFgoWt7vgJbG8ue40aW3d6nNZCzF84uGZND47ncFPZWpxGXDIjxgS9rrcyDmsgyetu7LD6rw%2BqkwdfW1AUBfG4a5Yhuvvu1QtV3QE3OKch4CbdKDoYdYYYefCpLNM%2BexJjMV2AIRqfBTPAnx%2FZdzMHBVuVVEPfDqrN%2B8wG6zjderc%2B1W9jEzQqq6YLbxZwrmBpYrzNEzEtxu13MWs0JehvpzGnkYKInBS7jJtS3tkZdNAAMGU8jiHXot1x8YC4GQhbcXuK3q9SxRdNed2gAtw6135nugN8%2BeNiRsVhYO5HBWlHCuXBmGqsJp9e6tzwF8fohi54YZfxZPYM0IyVE6Eg1ulgfnEZ3rAZDTPzGmpCu8FqoDcH55pJlf83spnhkPDuUYkE4IBPscCNnoxYQOff41bmLjRw7qGoJizj%2B%2BQ23mIOTdZrEemf947SuBZzUV9O3J0f%2BscDeGBH1GQXtuTI3n0bkbXaJckhbRj1MdGDujCeGCThw8f3uHfrrvail9zYlV%2F3wvwbC%2Bl1CR3zmf614bdcLQeFlHZl1T9teRLmSwGG%2BF4eYt9tsJQzOvBZnUJQXAbEcmaqq%2FscuaRpqgREtzbV1vcZkbDuTrykI5K917BYzi1K5rP7ziSuY%2B0EPRMtnkF6zyENi2gUw5zEuMIeMbahUGsXGDKh2RmHsIMNeL27cGOrEBv%2BJFeclfM98ADu0afkjh6ZFekuPSXbpitqyuULpKQr1d%2BU%2FD4r%2B5Kp892hLBABccRe%2BUbMi2ARRPZTArRF4nIxC0R1otNzM2aD4Tb0FY2WAUvsPaeroAXxqcTNKOjkeQ7AOhW24XvrawwpHfYXYbocaRJnTOSCJgVFWgEd2eIx4cki8V83w%2BBXJ4DACtZb5OohBleG8YTRxgWU4lTLs4unC9rGu6my8eUgZIJ3gpiS22&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240927T162404Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Credential=ASIAQ3PHCVTYZSOCUIYN%2F20240927%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=fbf4aeb21d15feeebb3b858e8cfc06fea3f5fa46f65a126db27aa5a42581abe1&hash=9409fab9678a5e5e71fffe1b9e0e8af84f7319fc89f11a26cbe43b4a7af3fc84&host=68042c943591013ac2b2430a89b270f6af2c76d8dfd086a07176afe7c76c2c61&pii=S0951832018301406&tid=spdf-8e0342b3-e68a-4672-b2e0-c0c32c99d50d&sid=73f323dd40c6e842628bdea3793ab7c0f495gxrqa&type=client&tsoh=d3d3LnNjaWVuY2VkaXJlY3QuY29t&ua=0f1559055b0604515c5d52&rr=8c9cd7835f27fa72&cc=us\n",
+    "<\\span>"
    ]
   },
   {