Release/v1.5

[teubert]

Release v1.5

• New model type: Direct Models. Direct Models directly map current state and future load to time of event, rather than state-transition models which simulate forward to calculate time of event
• New model types that combine multiple models:
  • EnsembleModel: combinations of multiple models of the same system where results are aggregated
  • CompositeModel: combinations of models of different systems that are interdependent
    • New Model Type: Aircraft flight model interface, AircraftModel. Anticipated prognostics applications with the aircraft flight model include estimating and predicting loading of other aircraft systems (e.g., powertrain) and safety metrics.
    • New Model: Implemented Small Rotorcraft AircraftModel
    • New DataModel: Polynomial Chaos Expansion (PCE) Direct Surrogate model
    • Initial transition of Input/State/OutputContainer and SimResult to use Pandas DataFrame. This release will bring the interface more in compliance with DataFrames. v1.6 will fully transition the classes to DataFrames.
    • Implemented new metrics that can be used when calculating error: Root Mean Square Error (RMSE), Maximum Error (MAX_E), Mean Absolute Error (MAE), Mean Absolute Percentage Error (MAPE), and Dynamic Time Warping (DTW)
    • Error calculation metric can now be changed in estimate_params
    • Revamping integration:
    • New integration methods: RK4 and methods from scipy.integrate
    • Integration is now set at the model level. For continuous models the specified integration method will apply when calling next_state
    • Python 3.11 support
    • Various bug fixes and performance improvements

[codecov-commenter]

Codecov Report

Merging #558 (4fcd13a) into master (c31fbbc) will decrease coverage by 7.42%. The diff coverage is 84.10%.

@@            Coverage Diff             @@
##           master     #558      +/-   ##
==========================================
- Coverage   91.92%   84.50%   -7.42%     
==========================================
  Files          59       45      -14     
  Lines        4691     3504    -1187     
==========================================
- Hits         4312     2961    -1351     
- Misses        379      543     +164     

Impacted Files	Coverage Δ
src/prog_models/prognostics_model.py	85.63% <ø> (-5.77%)	:arrow_down:
src/prog_models/loading/moving_average.py	33.33% <33.33%> (ø)
src/prog_models/loading/gaussian_wrapper.py	45.45% <45.45%> (ø)
src/prog_models/models/battery_electrochem.py	79.16% <46.66%> (-17.39%)	:arrow_down:
src/prog_models/models/dcmotor_singlephase.py	47.05% <47.05%> (ø)
src/prog_models/utils/noise_functions.py	58.82% <51.72%> (-25.39%)	:arrow_down:
src/prog_models/utils/serialization.py	61.11% <61.11%> (ø)
...aft_model/vehicles/control/allocation_functions.py	62.50% <62.50%> (ø)
src/prog_models/utils/traj_gen/geometry.py	66.84% <66.84%> (ø)
prog_model_template.py	68.00% <77.77%> (-1.24%)	:arrow_down:
... and 34 more

... and 34 files with indirect coverage changes

[teubert]

Checklists

Aditya

• [x] Check that each new feature (in the release notes) has corresponding tests
• [x] Confirm all dependencies are in the following: setup.py, the bottom of dev_guide.rst
• [X] Run unit tests python -m tests, on
  • [X] Windows
  • [X] Intel Mac
  • [X] Apple Silicon Mac
• [X] If present, run manual tests python -m tests.test_manual
• [x] Review the template(s)
• [x] Review static-analysis/linter results
• [x] Review the tutorial
• [x] Check that all examples are tested
• [x] Check new files in PR for any accidentally added
• [x] Check documents
• [ ] Check that all desired examples are in docs
• [x] Review release notes (top of PR)

Miryam

• [x] Run doctests on examples in the file
• [x] Check that each new feature (in the release notes) has corresponding tests
• [x] Confirm all dependencies are in the following: setup.py, the bottom of dev_guide.rst
• [x] Run unit tests python -m tests, on your machine
• [x] If present, run manual tests python -m tests.test_manual
• [x] Review the template(s)
• [x] Review static-analysis/linter results
• [x] Review the tutorial
• [x] Run and review the examples
• [x] Check that all examples are tested
• [x] Check new files in PR for any accidentally added
• [x] Check documents
• [x] Check that all desired examples are in docs
• [x] Review release notes (top of PR)

Chris

• [x] Check that each new feature (in the release notes) has corresponding tests
• [x] Confirm all dependencies are in the following: setup.py, the bottom of dev_guide.rst
• [x] Confirm that all issues associated with the release have been closed (i.e., requirements have been met) or assigned to another release
• [x] Run unit tests python -m tests, on your machine
• [x] If present, run manual tests python -m tests.test_manual
• [x] Review the template(s)
• [x] Review static-analysis/linter results
• [x] Review the tutorial
• [x] Run and review the examples
• [x] Check that all examples are tested
• [x] Check new files in PR for any accidentally added
• [x] Check documents
• [x] Check that all desired examples are in docs
• [x] Rebuild sphinx documents: sphinx-build sphinx_config/ docs/
• [x] Review release notes (top of PR)
• [x] Update version number in src/*/init.py and setup.py
• [x] For releases adding new features- ensure that NASA release process has been followed.
• [x] Confirm that on GitHub Releases page, the next release has been started and that a schedule is present including at least Release Date, Release Review Date, and Release Branch Opening Date.`

[github-actions[bot]]

Benchmarking Results [Update] From:	Test	Time (s)
import main	0.14338129999999993
import thrown object	0.5356257
model initialization	0.13392720000000002
set noise	1.2562205
simulate	0.3199000999999999
simulate with saving	0.9886092
simulate with saving, dt	1.1455529000000002
simulate with printing results, dt	1.366612
Plot results	15.3793041
Metrics	0.03727999999999909
Surrogate Model Generation	3.468543799999999
surrogate sim	1.0782352999999993
surrogate sim, dt	2.7439006

To:

Test	Time (s)
import main	0.1451344000000001
import thrown object	0.5334447000000002
model initialization	0.16554460000000004
set noise	0.6977248999999999
simulate	0.5099019999999999
simulate with saving	1.4528309999999998
simulate with saving, dt	1.8856887000000002
simulate with printing results, dt	2.3321895
Plot results	15.3743043
Metrics	0.038281200000000126
Surrogate Model Generation	2.244344100000003
surrogate sim	1.4662775000000003
surrogate sim, dt	3.819375800000003

[teubert]

Completed Release Review on 6/23

Release items were identified and resolved on 6/28 Release checklist with completed

Confirmed to be ready for release by Chris Teubert, Katy Jarvis