Merge pull request #113 from nasa/release/v1.1

Release v1.1

Author: teubert

.github/workflows/python-package.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
 
     steps:
     - uses: actions/checkout@v2
@@ -48,7 +48,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
@@ -61,3 +61,59 @@ jobs:
         python -m pip install -e .
     - name: Run tests
       run: python -m tests
+  test_prog_algs_released:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e .
+    - name: Clone prog_algs
+      uses: actions/checkout@v2
+      with:
+        repository: nasa/prog_algs 
+        ref: refs/heads/master
+        path: prog_algs
+    - name: Install prog_algs
+      run: | 
+        python -m pip install -e ./prog_algs
+    - name: Run tests
+      run: |
+        cd prog_algs 
+        python -m tests
+  test_prog_algs_dev:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e .
+    - name: Clone prog_algs
+      uses: actions/checkout@v2
+      with:
+        repository: nasa/prog_algs 
+        ref: refs/heads/dev
+        path: prog_algs
+    - name: Install prog_algs
+      run: | 
+        python -m pip install -e ./prog_algs
+    - name: Run tests
+      run: |
+        cd prog_algs 
+        python -m tests

.gitignore

@@ -98,3 +98,5 @@ cython_debug/
 .pypirc
 
 ex.pickle
+
+.vscode/

README.md

@@ -1,48 +1,52 @@
 # Prognostics Model Python Package
+[![CodeFactor](https://www.codefactor.io/repository/github/nasa/prog_models/badge)](https://www.codefactor.io/repository/github/nasa/prog_models)
+[![GitHub License](https://img.shields.io/badge/License-NOSA-green)](https://github.com/nasa/prog_models/blob/master/license.pdf)
+[![GitHub Releases](https://img.shields.io/github/release/nasa/prog_models.svg)](https://github.com/nasa/prog_models/releases)
 
-The NASA Prognostic Model Package is a python modeling framework focused on defining and building models for prognostics (computation of remaining useful life) of engineering systems, and provides a set of prognostics models for select components developed within this framework, suitable for use in prognostics applications for these components.
+The NASA Prognostic Model Package is a Python framework focused on defining and building models for prognostics (computation of remaining useful life) of engineering systems, and provides a set of prognostics models for select components developed within this framework, suitable for use in prognostics applications for these components.
 
 This is designed to be used with the [Prognostics Algorithms Package](https://github.com/nasa/prog_algs).
 
 ## Installation 
 `pip3 install prog_models`
 
-## Documentation
+## [Documentation](https://nasa.github.io/prog_models/)
 See documentation [here](https://nasa.github.io/prog_models/)
 
 ## Repository Directory Structure 
 Here is the directory structure for the github repository 
 
-`prog_models/` - The prognostics model python package<br />
+`src/prog_models/` - The prognostics model python package<br />
 &nbsp;&nbsp; |-`models/` - Example models<br /> 
 &nbsp;&nbsp; |-`prognostics_model.py` - Physics-based model superclass of degraded system behavior<br />
+&nbsp;&nbsp; |-`sim_result.py` - Class for storing the result of a simulation (used by `prognostics_model`)<br />
 &nbsp;&nbsp; |-`visualize.py` - Visualization tools<br />
 `docs/` - Project documentation<br />
 `sphinx_config/` - Configuration for automatic documentation generation<br />
-`examples/` - Example python scripts using prog_models<br />
+`examples/` - Example Python scripts using prog_models<br />
 `tests/` - Tests for prog_models<br />
 `README.md` - The readme (this file)<br />
-`requirements.txt` - python library dependiencies required to be met to use this package. Install using `pip install -r requirements.txt`<br />
-`prog_model_template.py` - Template for Prognsotics Model<br />
+`requirements.txt` - Python library dependiencies required to be met to use this package<br />
+`prog_model_template.py` - Template for Prognostics Model<br />
 `tutorial.ipynb` - Tutorial (Juypter Notebook)
 
 ## Citing this repository
 Use the following to cite this repository:
 
 ```
-@misc{2020_nasa_prog_models,
+@misc{2021_nasa_prog_models,
     author    = {Christopher Teubert and Matteo Corbetta and Chetan Kulkarni and Matthew Daigle},
     title     = {Prognostics Models Python Package},
-    month     = Apr,
+    month     = Aug,
     year      = 2021,
-    version   = {1.0},
+    version   = {1.1},
     url       = {https://github.com/nasa/prog_models}
     }
 ```
 
 The corresponding reference should look like this:
 
-C. Teubert, M. Corbetta, C. Kulkarni, and M. Daigle, Prognostics Models Python Package, v1.0, Apr. 2021. URL https://github.com/nasa/prog_models.
+C. Teubert, M. Corbetta, C. Kulkarni, and M. Daigle, Prognostics Models Python Package, v1.1, Aug. 2021. URL https://github.com/nasa/prog_models.
 
 ## Acknowledgements
 The structure and algorithms of this package are strongly inspired by the [MATLAB Prognostics Model Library](https://github.com/nasa/PrognosticsModelLibrary). We would like to recognize Matthew Daigle and the rest of the team that contributed to the Prognostics Model Library for the contributions their work on the MATLAB library made to the design of prog_models

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: 675d177859b081b6bf3ea4f747cee0da
+config: 81423af7536daf0ca9477dc217470ab8
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/.doctrees/dev_guide.doctree

@@ -0,0 +1,46 @@
+# Copyright © 2021 United States Government as represented by the Administrator of the
+# National Aeronautics and Space Administration.  All Rights Reserved.
+
+"""
+Example of a battery being simulated for a set period of time and then till threshold is met. Run using the command `python -m examples.sim_battery_eol`
+"""
+
+from prog_models.models import BatteryElectroChem as Battery
+
+def run_example(): 
+    # Step 1: Create a model object
+    batt = Battery()
+
+    # Step 2: Define future loading function 
+    # Here we're using a function designed to charge until 0.95, 
+    # then discharge until 0.05
+    load = 1
+
+    def future_loading(t, x=None):
+        nonlocal load 
+
+        # Rule for loading after initialization
+        if x is not None:
+            # Current event state in the form {'EOD': <(0, 1)>, 'InsufficientCapacity': <(0, 1)>}
+            event_state = batt.event_state(x)
+            if event_state["EOD"] > 0.95:
+                load = 1  # Discharge
+            elif event_state["EOD"] < 0.05:
+                load = -1  # Charge
+        # Rule for loading at initialization
+        return {'i': load}
+
+    # Simulate to EOL Threshold
+    print('\n\n------------------------------------------------')
+    print('Simulating to threshold\n\n')
+    options = {
+        'save_freq': 1000,  # Frequency at which results are saved
+        'dt': 2,  # Timestep
+        'threshold_keys': ['InsufficientCapacity'],  # Simulate to InsufficientCapacity
+        'print': True
+    }
+    (times, inputs, states, outputs, event_states) = batt.simulate_to_threshold(future_loading, {'t': 18.95, 'v': 4.183}, **options)
+
+# This allows the module to be executed directly 
+if __name__ == '__main__':
+    run_example()

docs/.doctrees/environment.pickle

@@ -1,10 +1,11 @@
-# Copyright © 2021 United States Government as represented by the Administrator of the National Aeronautics and Space Administration.  All Rights Reserved.
+# Copyright © 2021 United States Government as represented by the Administrator of the
+# National Aeronautics and Space Administration.  All Rights Reserved.
+
 """
-Example performing a sensitivity analysis on a new model. Can be run using the following command `python -m examples.sensitivity_example`
+Example of a sensitivity analysis on a new model. Run using the command `python -m examples.sensitivity`
 """
 
 # Deriv prog model was selected because the model can be described as x' = x + dx*dt
-from prog_models import PrognosticsModel
 from .new_model import ThrownObject
 import numpy as np