Documentation updates

docs/_downloads/8b8068cadf898f26bec76d85c19e7d58/playback.py

@@ -84,7 +84,7 @@ def future_loading(t, x=None):
             z = {'t': float(row[2]), 'v': float(row[3])}
 
             # State Estimation Step
-            filt.estimate(t, i, z) 
+            filt.estimate(t, i, z)
             eod = batt.event_state(filt.x.mean)['EOD']
             print("  - Event State: ", eod)
 

docs/_sources/guide.rst

@@ -10,6 +10,24 @@ ProgPy Guide
    prog_algs_guide
    prog_server_guide
 
+The ProgPy framework consists of three key components that combine to create a flexible and extendible prognostics architecture.
+
+.. image:: images/ProgPyComponents.png
+    :align: center
+
+1. 
+    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 capabilities and prognostics tools) are built on top of a model.
+
+    ProgPy supports models that are physics-based, data-driven, or hybrid. ProgPy includes some built-in models (see examples below) but is also written in an easily adaptable way so users can implement models specific to their use-cases. 
+
+2. 
+    The **Prognostics Engine** encapsulates the complex logic of prognostics in a way that is modular and extendable. It includes the necessary tools to perform prognostics on the model, including state estimation, prediction, and uncertainty management. The modularity of the framework allows these capabilities to work with any model (built-in or user-defined) and the extensibility of the architecture allows users to additionally create their own methodologies. 
+
+3. 
+    The **Prognostics Support Tools** are a collection of capabilities to help users build new functionalities or understand prognostics results.
+
+These three key components come together to create the comprehensive framework that is ProgPy. More details will be shared in the coming pages. 
+
 This page is a general guide for ProgPy. To access a guide specific to the features you're using, select it in the menu below.
 
 .. panels::

docs/_sources/index.rst

@@ -38,6 +38,12 @@ Installing progpy
 
             $ pip install progpy
 
+        If you will be using the datadriven tools (e.g., LSTM model), install the datadriven dependencies as well using the following command:
+
+        .. code-block:: console
+
+            $ pip install progpy[datadriven]
+
     .. tab:: Pre-Release
 
         Users who would like to contribute to ProgPy or would like to use pre-release features can do so using the `ProgPy GitHub repo <https://github.com/nasa/progpy>`__. This isn't recommended for most users as this version may be unstable. To do this, use the following commands:
@@ -49,23 +55,29 @@ Installing progpy
             $ git checkout dev 
             $ pip install -e .
 
+        If you will be using the datadriven tools (e.g., LSTM model), install the datadriven dependencies as well using the following command:
+
+        .. code-block:: console
+
+            $ pip install -e '.[datadriven]'
+
 Citing This Repository
 -----------------------
 Use the following to cite this repository:
 
 @misc{2023_nasa_progpy,
   | author    = {Christopher Teubert and Katelyn Jarvis Griffith and Matteo Corbetta and Chetan Kulkarni and Portia Banerjee and Jason Watkins and Matthew Daigle},
   | title     = {{ProgPy Python Prognostics Packages}},
-  | month     = Oct,
-  | year      = 2023,
-  | version   = {1.6},
+  | month     = May,
+  | year      = 2024,
+  | version   = {1.7},
   | url       = {https://nasa.github.io/progpy}
   | doi       = {10.5281/ZENODO.8097013}
   | }
 
 The corresponding reference should look like this:
 
-C. Teubert, K. Jarvis Griffith, M. Corbetta, C. Kulkarni, P. Banerjee, J. Watkins, M. Daigle, ProgPy Python Prognostics Packages, v1.6, Oct 2023. URL https://github.com/nasa/progpy.
+C. Teubert, K. Jarvis Griffith, M. Corbetta, C. Kulkarni, P. Banerjee, J. Watkins, M. Daigle, ProgPy Python Prognostics Packages, v1.7, May 2024. URL https://github.com/nasa/progpy.
 
 Contributing and Partnering
 -----------------------------

docs/_sources/prog_models_guide.rst

@@ -323,6 +323,13 @@ State-transition Models
 
         The :py:func:`progpy.data_models.DataModel.from_data` and :py:func:`progpy.data_models.DataModel.from_model` methods are used to construct new models from data or an existing model (i.e., :term:`surrogate`), respectively. The use of these is demonstrated in the following examples.
 
+        .. note:: 
+            To use a data-driven model distributed with progpy you need to install the data-driven dependencies.
+
+            .. code-block:: console
+
+                $ pip install progpy[datadriven] 
+
         * :download:`examples.lstm_model <../../progpy/examples/lstm_model.py>`
             .. automodule:: lstm_model
 

docs/_static/documentation_options.js

@@ -7,7 +7,7 @@ var DOCUMENTATION_OPTIONS = {
     FILE_SUFFIX: '.html',
     LINK_SUFFIX: '.html',
     HAS_SOURCE: true,
-    SOURCELINK_SUFFIX: '.txt',
+    SOURCELINK_SUFFIX: '',
     NAVIGATION_WITH_KEYS: true,
     SHOW_SEARCH_SUMMARY: true,
     ENABLE_SEARCH_SHORTCUTS: true,

docs/_static/locales/ar/LC_MESSAGES/booktheme.po

@@ -8,74 +8,68 @@ msgstr ""
 "Language: ar\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
-msgid "repository"
-msgstr "مخزن"
-
-msgid "open issue"
-msgstr "قضية مفتوحة"
-
-msgid "Contents"
-msgstr "محتويات"
-
-msgid "Fullscreen mode"
-msgstr "وضع ملء الشاشة"
+msgid "suggest edit"
+msgstr "أقترح تحرير"
 
-msgid "Download this page"
-msgstr "قم بتنزيل هذه الصفحة"
+msgid "Last updated on"
+msgstr "آخر تحديث في"
 
-msgid "Download source file"
-msgstr "تنزيل ملف المصدر"
+msgid "Edit this page"
+msgstr "قم بتحرير هذه الصفحة"
 
 msgid "Launch"
 msgstr "إطلاق"
 
-msgid "Edit this page"
-msgstr "قم بتحرير هذه الصفحة"
+msgid "Print to PDF"
+msgstr "طباعة إلى PDF"
+
+msgid "open issue"
+msgstr "قضية مفتوحة"
+
+msgid "Download notebook file"
+msgstr "تنزيل ملف دفتر الملاحظات"
 
 msgid "Toggle navigation"
 msgstr "تبديل التنقل"
 
-msgid "Theme by the"
-msgstr "موضوع بواسطة"
-
 msgid "Source repository"
 msgstr "مستودع المصدر"
 
-msgid "Last updated on"
-msgstr "آخر تحديث في"
-
 msgid "By the"
 msgstr "بواسطة"
 
+msgid "next page"
+msgstr "الصفحة التالية"
+
+msgid "repository"
+msgstr "مخزن"
+
 msgid "Sphinx Book Theme"
 msgstr "موضوع كتاب أبو الهول"
 
-msgid "Open an issue"
-msgstr "افتح قضية"
+msgid "Download source file"
+msgstr "تنزيل ملف المصدر"
 
-msgid "next page"
-msgstr "الصفحة التالية"
+msgid "Contents"
+msgstr "محتويات"
+
+msgid "By"
+msgstr "بواسطة"
 
 msgid "Copyright"
 msgstr "حقوق النشر"
 
-msgid "Search this book..."
-msgstr "بحث في هذا الكتاب ..."
-
-msgid "Print to PDF"
-msgstr "طباعة إلى PDF"
+msgid "Fullscreen mode"
+msgstr "وضع ملء الشاشة"
 
-msgid "By"
-msgstr "بواسطة"
+msgid "Open an issue"
+msgstr "افتح قضية"
 
 msgid "previous page"
 msgstr "الصفحة السابقة"
 
-msgid "Search the docs ..."
-msgstr "ابحث في المستندات ..."
-
-msgid "Download notebook file"
-msgstr "تنزيل ملف دفتر الملاحظات"
+msgid "Download this page"
+msgstr "قم بتنزيل هذه الصفحة"
 
-msgid "suggest edit"
-msgstr "أقترح تحرير"
+msgid "Theme by the"
+msgstr "موضوع بواسطة"

docs/_static/locales/bg/LC_MESSAGES/booktheme.po

@@ -8,74 +8,68 @@ msgstr ""
 "Language: bg\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
-msgid "repository"
-msgstr "хранилище"
-
-msgid "open issue"
-msgstr "отворен брой"
-
-msgid "Contents"
-msgstr "Съдържание"
-
-msgid "Fullscreen mode"
-msgstr "Режим на цял екран"
+msgid "suggest edit"
+msgstr "предложи редактиране"
 
-msgid "Download this page"
-msgstr "Изтеглете тази страница"
+msgid "Last updated on"
+msgstr "Последна актуализация на"
 
-msgid "Download source file"
-msgstr "Изтеглете изходния файл"
+msgid "Edit this page"
+msgstr "Редактирайте тази страница"
 
 msgid "Launch"
 msgstr "Стартиране"
 
-msgid "Edit this page"
-msgstr "Редактирайте тази страница"
+msgid "Print to PDF"
+msgstr "Печат в PDF"
+
+msgid "open issue"
+msgstr "отворен брой"
+
+msgid "Download notebook file"
+msgstr "Изтеглете файла на бележника"
 
 msgid "Toggle navigation"
 msgstr "Превключване на навигацията"
 
-msgid "Theme by the"
-msgstr "Тема от"
-
 msgid "Source repository"
 msgstr "Хранилище на източника"
 
-msgid "Last updated on"
-msgstr "Последна актуализация на"
-
 msgid "By the"
 msgstr "По"
 
+msgid "next page"
+msgstr "Следваща страница"
+
+msgid "repository"
+msgstr "хранилище"
+
 msgid "Sphinx Book Theme"
 msgstr "Тема на книгата Sphinx"
 
-msgid "Open an issue"
-msgstr "Отворете проблем"
+msgid "Download source file"
+msgstr "Изтеглете изходния файл"
 
-msgid "next page"
-msgstr "Следваща страница"
+msgid "Contents"
+msgstr "Съдържание"
+
+msgid "By"
+msgstr "От"
 
 msgid "Copyright"
 msgstr "Авторско право"
 
-msgid "Search this book..."
-msgstr "Търсене в тази книга ..."
-
-msgid "Print to PDF"
-msgstr "Печат в PDF"
+msgid "Fullscreen mode"
+msgstr "Режим на цял екран"
 
-msgid "By"
-msgstr "От"
+msgid "Open an issue"
+msgstr "Отворете проблем"
 
 msgid "previous page"
 msgstr "предишна страница"
 
-msgid "Search the docs ..."
-msgstr "Търсене в документите ..."
-
-msgid "Download notebook file"
-msgstr "Изтеглете файла на бележника"
+msgid "Download this page"
+msgstr "Изтеглете тази страница"
 
-msgid "suggest edit"
-msgstr "предложи редактиране"
+msgid "Theme by the"
+msgstr "Тема от"