Merge pull request #169 from nasa/release/v1.7

Release v1.7

.github/workflows/coverage.yml

@@ -23,7 +23,7 @@ jobs:
       uses: actions/cache@v2
       with:
         path: ~/.cache/pip
-        key: pip-cache
+        key: pip-cache-datadriven
     - name: Install additional dependencies
       run: |
         pip install coverage

.github/workflows/python-package.yml

@@ -113,9 +113,9 @@ jobs:
       uses: actions/cache@v2
       with:
         path: ~/.cache/pip
-        key: pip-cache
+        key: pip-cache-datadriven
     - name: Update
-      run: pip install --upgrade --upgrade-strategy eager -e .
+      run: pip install --upgrade --upgrade-strategy eager -e .[datadriven]
     - name: Run tests
       run: python -m tests.test_data_model
   test_datasets:
@@ -421,32 +421,32 @@ jobs:
       uses: actions/cache@v2
       with:
         path: ~/.cache/pip
-        key: pip-cache
+        key: pip-cache-datadriven
     - name: Update
-      run: pip install --upgrade --upgrade-strategy eager -e .
+      run: pip install --upgrade --upgrade-strategy eager -e .[datadriven]
     - name: Run tests
       run: python -m tests.test_surrogates
-  test_tutorials:
-    timeout-minutes: 5
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.7'
-    - name: Install dependencies cache
-      uses: actions/cache@v2
-      with:
-        path: ~/.cache/pip
-        key: pip-cache
-    - name: Update
-      run: |
-        pip install --upgrade --upgrade-strategy eager -e .
-        pip install notebook
-        pip install testbook
-    - name: Run tests
-      run: python -m tests.test_tutorials
+  # test_tutorials:
+  #   timeout-minutes: 5
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #   - uses: actions/checkout@v3
+  #   - name: Set up Python
+  #     uses: actions/setup-python@v4
+  #     with:
+  #       python-version: '3.7'
+  #   - name: Install dependencies cache
+  #     uses: actions/cache@v2
+  #     with:
+  #       path: ~/.cache/pip
+  #       key: pip-cache-datadriven
+  #   - name: Update
+  #     run: |
+  #       pip install --upgrade --upgrade-strategy eager -e .
+  #       pip install notebook
+  #       pip install testbook
+  #   - name: Run tests
+  #     run: python -m tests.test_tutorials
   test_uav_model:
     timeout-minutes: 10
     runs-on: ubuntu-latest

.github/workflows/update-cache.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7']
+        python-version: ['3.10']
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -16,11 +16,35 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install -e .
+        python -m pip install -e .[datadriven]
         python -m pip install notebook
         python -m pip install testbook
         python -m pip install requests
     - uses: actions/cache@v3
       with:
         path: ~/.cache/pip
         key: pip-cache
+
+  cache-dependencies-data-driven:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10']
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e '.[datadriven]'
+        python -m pip install notebook
+        python -m pip install testbook
+        python -m pip install requests
+    - uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: pip-cache-datadriven

README.md

@@ -13,6 +13,12 @@ ProgPy combines NASAs prog_models and prog_algs packages into a single python pa
 ## Installation 
 `pip3 install progpy`
 
+or 
+
+`pip3 install progpy[datadriven]`
+
+to include dependencies for data driven models
+
 ## [Documentation](https://nasa.github.io/progpy/)
 See documentation [here](https://nasa.github.io/progpy/)
 
@@ -26,26 +32,24 @@ Here is the directory structure for the github repository
 `prog_model_template.py` - Template for Prognostics Model<br />
 `state_estimator_template.py` - Template for State Estimators<br />
 `predictor_template.py` - Template for Predictor<br />
-`tutorial.ipynb` - Tutorial (Juypter Notebook)
 
 ## Citing this repository
 Use the following to cite this repository:
 
 ```
-@misc{2023_nasa_progpy,
+@misc{2024_nasa_progpy,
   | author    = {Christopher Teubert and Katelyn Jarvis Griffith and Matteo Corbetta and Chetan Kulkarni and Portia Banerjee 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, 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, M. Daigle, ProgPy Python Prognostics Packages, v1.7, May 2024. URL https://github.com/nasa/progpy.
 
 ## Contributing Organizations
 ProgPy was created by a partnership of multiple organizations, working together to build a set of high-quality prognostic tools for the wider PHM Community. We would like to give a big thank you for the ProgPy community, especially the following contributing organizations:

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e5348f79dd5ab46a199baa607858f4a9
+config: 7d941a484a4f3440c5e3ef5478d11930
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_downloads/0e5fd1a6bf0ee8b3ff6785357ecebade/online_prog.py

@@ -13,10 +13,10 @@
 from time import sleep
 
 def run_example():
-    # Step 1: Open a session with the server for a thrown object. 
+    # Step 1: Open a session with the server for a thrown object.
     # Use all default configuration options.
     # Except for the save frequency, which we'll set to 1 second.
-    session = prog_client.Session('ThrownObject', pred_cfg =  {'save_freq': 1})
+    session = prog_client.Session('ThrownObject', pred_cfg={'save_freq': 1})
     print(session)  # Printing the Session Information
 
     # Step 2: Prepare data to send to server
@@ -58,7 +58,7 @@ def run_example():
     for i in range(len(example_data)):
         # Send data to server
         print(f'{example_data[i][0]}s: Sending data to server... ', end='')
-        session.send_data(time = example_data[i][0], **example_data[i][1])
+        session.send_data(time=example_data[i][0], **example_data[i][1])
 
         # Check for a prediction result
         status = session.get_prediction_status()