Release Review Checklist Items

[aqitya]

Complete release review checklist items, namely:

• PrognosticsModel.is_direct_model() -> is_direct() – also everywhere else it’s used
• Add Version note to top of doccomments for all new classes/functions (see release notes) .. versionadded:: 1.5.0
• Rename Chaos example to PCE
• Calc_error: doccomment – x0 as state container, not dict
• test - error_method in estimate params
• In class doccomments for integration_method argument: - next state -> next_state
• In State estimators doccomments
  • Doccomments for each state estimator. Description of dt should be difference from the last call of .estimate()
  • by default dt is the difference
  • parameters[‘dt’] (missing second quote)

[github-actions[bot]]

Thank you for opening this PR. Since this is a release branch, the PR must complete the release checklist, below:

• [ ] Check that each new feature has corresponding tests

• [ ] Confirm all dependencies are in the following: requirements.txt, setup.py, the bottom of dev_guide.rst

• [ ] Confirm that all issues associated with the release have been closed (i.e., requirements have been met) or assigned to another release

• [ ] Run unit tests python -m tests, on

  • [ ] Windows

  • [ ] Linux

  • [ ] Apple Silicon Mac

  • [ ] Intel Mac

• [ ] If present, run manual tests python -m tests.test_manual

• [ ] Review the template(s)

• [ ] Review static-analysis/linter results

• [ ] Review the tutorial

• [ ] Run and review the examples

• [ ] Check that all examples are tested

• [ ] Check new files in PR for any accidentally added

• [ ] Check documents

  • [ ] Check that all desired examples are in docs

  • [ ] General review: see if any updates are required

• [ ] Rebuild sphinx documents: sphinx-build sphinx_config/ docs/

• [ ] Write release notes

• [ ] Update version number in src/*/init.py and setup.py

• [ ] For releases adding new features- ensure that NASA release process has been followed.

• [ ] 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 From:	Test	Time (s)
import main	0.11801529999999993
import thrown object	0.5170482999999999
model initialization	0.1567031000000001
set noise	0.6895450000000003
simulate	0.49858
simulate with saving	1.4074271
simulate with saving, dt	1.8314379
simulate with printing results, dt	2.2710587999999996
Plot results	14.659388199999999
Metrics	0.04247270000000114
Surrogate Model Generation	2.1796308000000018
surrogate sim	1.3617618
surrogate sim, dt	3.6918149999999983

To:	Test	Time (s)
import main	0.11237680000000005
import thrown object	0.4947771000000001
model initialization	0.15596869999999985
set noise	0.6893411
simulate	0.4985503000000002
simulate with saving	1.3895220000000004
simulate with saving, dt	1.7927356000000003
simulate with printing results, dt	2.2623586000000007
Plot results	14.686725899999999
Metrics	0.04214749999999867
Surrogate Model Generation	2.1774552000000007
surrogate sim	1.3603170999999996
surrogate sim, dt	3.686249799999999

[codecov-commenter]

Codecov Report

Merging #567 (f559b18) into release/v1.5 (e57bd05) will not change coverage. The diff coverage is 100.00%.

:exclamation: Current head f559b18 differs from pull request most recent head aa2c981. Consider uploading reports for the commit aa2c981 to get more accurate results

@@              Coverage Diff              @@
##           release/v1.5     #567   +/-   ##
=============================================
  Coverage         84.61%   84.61%           
=============================================
  Files                45       45           
  Lines              3504     3504           
=============================================
  Hits               2965     2965           
  Misses              539      539           

Impacted Files	Coverage Δ
prog_model_template.py	68.00% <ø> (ø)
src/prog_models/composite_model.py	89.93% <ø> (ø)
src/prog_models/ensemble_model.py	100.00% <ø> (ø)
src/prog_models/loading/controllers.py	98.38% <ø> (ø)
src/prog_models/loading/gaussian_wrapper.py	45.45% <ø> (ø)
src/prog_models/loading/moving_average.py	33.33% <ø> (ø)
src/prog_models/loading/piecewise.py	100.00% <ø> (ø)
src/prog_models/models/aircraft_model/aircraft.py	100.00% <ø> (ø)
...g_models/models/aircraft_model/small_rotorcraft.py	82.64% <ø> (ø)
...odels/aircraft_model/vehicles/aero/aerodynamics.py	100.00% <ø> (ø)
... and 7 more

[github-actions[bot]]

Benchmarking Results [Update] From:	Test	Time (s)
import main	0.1699199
import thrown object	0.5996287000000002
model initialization	0.23593300000000017
set noise	0.8170591999999997
simulate	0.710366
simulate with saving	2.0203650999999994
simulate with saving, dt	2.5780341
simulate with printing results, dt	3.229384699999999
Plot results	22.787603600000004
Metrics	0.04240459999999757
Surrogate Model Generation	3.3015716000000026
surrogate sim	2.376663300000004
surrogate sim, dt	5.4850925

To:

Test	Time (s)
import main	0.15265020000000007
import thrown object	0.5834808999999999
model initialization	0.23670090000000021
set noise	0.7870170000000001
simulate	0.7322105999999997
simulate with saving	2.0595568
simulate with saving, dt	2.5411156999999998
simulate with printing results, dt	3.231579400000001
Plot results	22.6408475
Metrics	0.04998319999999978
Surrogate Model Generation	3.2667591000000016
surrogate sim	2.4062623000000016
surrogate sim, dt	5.5303763

[github-actions[bot]]

Benchmarking Results [Update] From:	Test	Time (s)
import main	0.16303140000000016
import thrown object	0.6056430000000002
model initialization	0.23711349999999998
set noise	0.7944743999999999
simulate	0.7409956000000002
simulate with saving	2.1731624
simulate with saving, dt	2.6849086999999994
simulate with printing results, dt	3.3017729000000013
Plot results	22.5099581
Metrics	0.04570710000000133
Surrogate Model Generation	3.3558207999999965
surrogate sim	2.412059300000003
surrogate sim, dt	5.536230800000006

To:

Test	Time (s)
import main	0.15725279999999975
import thrown object	0.5736316000000001
model initialization	0.24135410000000013
set noise	0.8197845000000004
simulate	0.6783469999999996
simulate with saving	2.0209124999999997
simulate with saving, dt	2.449019399999999
simulate with printing results, dt	3.1517646
Plot results	22.3952295
Metrics	0.04513569999999589
Surrogate Model Generation	3.2520568999999995
surrogate sim	2.3379255999999984
surrogate sim, dt	5.357263500000002

[github-actions[bot]]

Benchmarking Results [Update] From:	Test	Time (s)
import main	0.12227149999999987
import thrown object	0.4963686999999999
model initialization	0.15619800000000006
set noise	0.687888
simulate	0.5051686000000002
simulate with saving	1.4008813
simulate with saving, dt	1.8204253000000001
simulate with printing results, dt	2.2693732000000004
Plot results	14.7974209
Metrics	0.04214939999999956
Surrogate Model Generation	2.1826828999999996
surrogate sim	1.3633525000000013
surrogate sim, dt	3.7765856000000007

To:

Test	Time (s)
import main	0.12147989999999997
import thrown object	0.5157353
model initialization	0.15638379999999996
set noise	0.6908285000000003
simulate	0.49836230000000015
simulate with saving	1.3952460999999996
simulate with saving, dt	1.8010058999999998
simulate with printing results, dt	2.2464551000000004
Plot results	14.572998599999998
Metrics	0.04233759999999975
Surrogate Model Generation	2.1682158000000022
surrogate sim	1.3540845000000026
surrogate sim, dt	3.674191299999997

[github-actions[bot]]

Benchmarking Results [Update] From:	Test	Time (s)
import main	0.15674710000000003
import thrown object	0.6058481999999998
model initialization	0.1916161999999999
set noise	0.7801125999999998
simulate	0.5788107
simulate with saving	1.6988430000000005
simulate with saving, dt	2.1745928
simulate with printing results, dt	2.7452211999999996
Plot results	17.7008517
Metrics	0.04222259999999878
Surrogate Model Generation	2.4896405
surrogate sim	1.6495433000000013
surrogate sim, dt	4.232137700000003

To:

Test	Time (s)
import main	0.1541007000000001
import thrown object	0.6286954999999999
model initialization	0.19271220000000033
set noise	0.7679907999999998
simulate	0.5936011999999997
simulate with saving	1.7197486
simulate with saving, dt	2.1504594
simulate with printing results, dt	2.5333856
Plot results	17.305447100000002
Metrics	0.04238940000000113
Surrogate Model Generation	2.4649639000000008
surrogate sim	1.6498155000000025
surrogate sim, dt	4.223456599999999

[github-actions[bot]]

Benchmarking Results [Update] From:	Test	Time (s)
import main	0.13296019999999986
import thrown object	0.4976890999999999
model initialization	0.1588527999999998
set noise	0.6610667000000001
simulate	0.4979513
simulate with saving	1.4033480999999997
simulate with saving, dt	1.8123931999999998
simulate with printing results, dt	2.2439351000000007
Plot results	14.7670418
Metrics	0.03635979999999961
Surrogate Model Generation	2.1611303
surrogate sim	1.4336292999999998
surrogate sim, dt	3.7193547000000002

To:

Test	Time (s)
import main	0.12757909999999995
import thrown object	0.49648590000000015
model initialization	0.15784779999999987
set noise	0.6545922999999996
simulate	0.48934710000000026
simulate with saving	1.4191188999999995
simulate with saving, dt	1.8117964000000004
simulate with printing results, dt	2.2140727
Plot results	14.564417999999998
Metrics	0.03686619999999863
Surrogate Model Generation	2.1625008
surrogate sim	1.4330183999999981
surrogate sim, dt	3.6759371000000023

[github-actions[bot]]

Benchmarking Results [Update] From:	Test	Time (s)
import main	0.11222390000000004
import thrown object	0.5005790999999999
model initialization	0.1537556
set noise	0.6717865999999999
simulate	0.49773840000000025
simulate with saving	1.3801568
simulate with saving, dt	1.7980550000000006
simulate with printing results, dt	2.247342999999999
Plot results	13.961194
Metrics	0.0409809999999986
Surrogate Model Generation	2.134270200000003
surrogate sim	1.3385409000000017
surrogate sim, dt	3.6325894000000005

To:

Test	Time (s)
import main	0.11717500000000003
import thrown object	0.4945576999999999
model initialization	0.1545006
set noise	0.6721360000000001
simulate	0.4979551999999998
simulate with saving	1.3870402000000004
simulate with saving, dt	1.7809870000000005
simulate with printing results, dt	2.239080200000001
Plot results	13.8850286
Metrics	0.041814999999999714
Surrogate Model Generation	2.1553691000000015
surrogate sim	1.3514541000000015
surrogate sim, dt	3.6459966