Fmdtools

Latest version: v2.0.5

Safety actively analyzes 688126 Python packages for vulnerabilities to keep your Python projects secure.

Page 3 of 4

2.0beta3

**Overall Summary:**
This PR covers the reimplementation of fmdtools.sim.search.ProblemInterface as:
• ParameterSimProblem, a class for optimizing parameters over simulations
• FaultSimProblem, a class for optimizing fault times
• DisturbanceSimProblem, a class for optimizing disturbances in the context of a simulation
• SimpleProblem, a class for setting up external function calls in an optimization
• ProblemArchitecture, a class for connecting different problems in an overall optimization architecture
It also covers adaptation of examples and tests to fit this:
• Pump optimization
• Drone/multirotor optimization
• Tank optimization
• New exampes/tests in the docstrings
Also in this PR are some bugfixes for the new version of recordclass (0.21).

**Commit Narrative:**
• Developing ParameterSearch class
o ParameterSearch will be used to search ParameterDomains over sims
o Add ability to pass variable mappings to ParameterDomains so you can search/sample discrete parameters more easily
• Adding tests/docs to ParameterProblem
o ExampleParameter, ExampleState, ExampleFxnBlocks defined in respective modules for testing purposes
o Tests added to ParameterProblem showcasing input/output callables
• Adding ParameterProblem to Search
o ParameterProblem added to search
o Some consolidation of drone scripts
• Adding tests for Drone to example
o Basic search tests added for Drone
o Variables now nan at initialization (instead of 0.0)
• Adding single-fault and disturbance optimization classes
-DisturbanceProblem, SingleFaultProblem now available for optimizaiton
o Tests of both in docs + drone model
o Fixed bug in Block copying--no longer requires new flows
o Single/JointFault scenario generation moved to respective scenario classes form sample.
• Developing SimpleProblem
o SimpleProblem added to search for callables which will be input to a ProblemArchitecture for the Drone (and others)
• More initial work on ProblemArchitecture
• Update search_testing.py
• More prototyping of ProblemArchitechture
• Adding way to connect/update variables in ProblemArchitectechture
• Further work on Problem Architecture
o Creating test problemarch to use in doctest
o Made it so that Problem tests can be imported from the module (and into ProblemArch)
• Creating initial docstrings for ProblemArchitecture
• Adding preliminary tests to ProblemArchitecture
o doctests now used for some problemarchitecture functions
• More development of ProblemArchitecture
o ProblemArch now mirrors objectives/constraints at arch level
o ProblemArch now creates callables for objectives/constraints at arch level
o ProblemArch now checks/updates consistency of upstream/downstream sims
• Incorporating ParameterArchitecture in search
o Added tests, examples, and docstrings to ParameterArchitecture.
o ParameterArchitecture moved from search_testing to search.
• Reformat DynamicInterface
DynamicInterface now follows programming style
• Adapting Drone Optimization
o drone_opt_rural now has problems defined
o adding better support for nested variables--now properly sets args
• More drone optimization adaptation
o Full optimization architecture implemented on drone arch
o Added ability to not include nominal result in fault scenario optimization
• Update recordclass requirement
o Recordclass to be used now 0.21.1, updated docs and modules to reflect this
• Adding optimization problem timing, history
o iter_hist now records the problem iterations
o time_execution can now be used to time the amount of time a problem takes to sim/update
o some adaptation of common and history to support iteration histories
• Adding ability to use history values as objectives/constraints
• Drone optimization example now working/up-to-date
o Adapted multirotor optimization notebook and consolidated codes from opt_drone_rural and search_testing into it
o propagate now has a fault_sample_from method which auto-generates a SampleApproach from arguments/nominal
o some polishing of search methods--now make it so showprogress=false by default, can work with multiple returns
o fixed various bugs in the drone model, coords, rand
• Adapting pump optimization
o bugfixing so that states etc copy instead of use defaults
o halfway done on pump optimization notebook
o some fixes to pump_stochastic.py
• Finishing Pump Optimization
o Optimization notebook for pump finished
o 'expected cost' changed to 'expected_cost' everywhere
• Finished adapting tank optimization example
o Tank optimization notebook completed. This notebook incorporates all functions from tank_opt.py
o Fixed bugs in tank optimization model
o Fixed bugs in search--objective connectors now work as desired
o closes [RAD-328](https://babelfish.arc.nasa.gov/jira/browse/RAD-328)

**Checklist**

<html xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:w="urn:schemas-microsoft-com:office:word"
xmlns:m="http://schemas.microsoft.com/office/2004/12/omml"
xmlns="http://www.w3.org/TR/REC-html40">

<head>

<meta name=ProgId content=Word.Document>
<meta name=Generator content="Microsoft Word 15">
<meta name=Originator content="Microsoft Word 15">
<link rel=File-List
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_filelist.xml">

<link rel=themeData
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_themedata.thmx">
<link rel=colorSchemeMapping
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_colorschememapping.xml">

<style>

</style>

</head>

<body lang=EN-US style='tab-interval:.5in;word-wrap:break-word'>


Step | Description | Complete? | Comment
-- | -- | -- | --
1 | Sync appropriate branches into release branch | x | Nothing new
1a | Internal branches (e.g. main dev) | x |
1b | External branches (e.g. main) | x |
2 | Run script run_all_tests.py and verify test results are appropriate | x | Flagged two notebooks to fix: multirotor demonstration and tank optimization. Other notebooks should also be fixed in the next few efforts.
2a | Run full tests | x | 10 failures, 4 warnings, 15 errors, 226 passed. Significant number of tests added in this cycle. Failures mainly reflect unimplemented examples
2b | Regenerate badge | x |
3 | Update version numbers in appropriate files | x |
3a | Check files conf.py LICENSE.py README.py Intro_to_fmdtools.md | x |
3b | Run a repository-wide search for the version number | x |
4 | Generate the documentation using “./make html” | x | Generated, some formatting errors found and flagged to be fixed.
5 | Commit and tag branch with the appropriate version. | X |
5a | git tag -a v2.x.x -m ‘version 2.x.x’ | x |
6 | Sync to remotes | x |
6a | Push release branch to github and internal remotes | x |
6b | Overwrite documentation on gh-pages and push to GitHub | x |
7 | Create a release in GitHub | x |
7a | incorporate a narrative summary of features and changes | x |
7b | incorporate the auto-generated bitbucket release notes. | x |
9 | Update/check external CI resources as needed | x |
9a | CodeFactor | x |
10 | If release is ‘stable’ Upload to PyPI (see below | |


</body>

</html>

2.0beta2

Summary

This second beta milestone for the `fmdtools-2.0` development cycle has focused on the refactoring of fault and parameter sampling functionality, along with the `analyze` module as a whole. Notably, this refactoring has **increased our codefactor score from C+ to B+**, mainly from the refactoring of major trouble spots like fmdtools.sim.approach and fmdtools.analyze.plot. Throughout this process, we also have added **57 new tests**, bringing us to 266 from 209.

Details
* Replacement of approach module (NominalApproach and SampleApproach) with analyze.phases and sim.sample modules with the following classes:
* FaultDomain for specifying types of fault modes to sample from
* FaultSample for sampling these modes (Generating FaultScenarios)
* PhaseMap for (and phases module) for representing phases of operation from the model history for fault sampling
* SampleApproach for joining multiple faultsamples over multiple FaultDomains
* ParameterDomain for defining variables to sample from parameters
* ParameterSample for sampling parameters from a parameterdomain (generating ParameterScenarios)
* Adaptation of propagate methods to align with these new names/classes. e.g., propagate.nominal_approach is now propagate.parameter_sample, etc.
* Replacement of tabulate/plot methods with classes that perform the same role
* FMEA taking the role of fmea()
* Comparison taking the role of nominal_factor_comparison, nested_factor, comparison, etc
* NominalEnvelope taking the role of plot.nominal_vals_xd
* Refactoring analyze functionality to follow an object-oriented (rather than module-oriented) convention:
* show module methods now a part of their respective classes (Geom, Coords, etc)
* plot_dyn_order now a part of Model
* plot_trajectories and plot_hist now a part of History
* plot_metric now a part of Result, History
* Creation of a analyze.common module for remaining base plot, analysis functionality
* Removal of show, plot modules
* Adaptation of presently-working examples and tests.

Auto-generated release notes:

<h2> Sub-task
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-96'>RAD-96</a>] - Refactor SampleApproach
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-255'>RAD-255</a>] - Adapt SampleApproach Use-cases in Rover Example
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-259'>RAD-259</a>] - Enable exploration of sub-parameters in NominalApproach
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-268'>RAD-268</a>] - Update Propagate methods
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-272'>RAD-272</a>] - Fix complexity in plot module
</li>
</ul>

<h2> Epic
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-70'>RAD-70</a>] - Create function, flow, patterns/attributes for next generation of the Stereo Model
</li>
</ul>

<h2> Story
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-258'>RAD-258</a>] - Fix/update tabulate module and less-used plot methods
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-260'>RAD-260</a>] - Refactor approach classes
</li>
</ul>

Release checklist

<html xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:w="urn:schemas-microsoft-com:office:word"
xmlns:m="http://schemas.microsoft.com/office/2004/12/omml"
xmlns="http://www.w3.org/TR/REC-html40">

<head>

<meta name=ProgId content=Word.Document>
<meta name=Generator content="Microsoft Word 15">
<meta name=Originator content="Microsoft Word 15">
<link rel=File-List
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_filelist.xml">

<link rel=themeData
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_themedata.thmx">
<link rel=colorSchemeMapping
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_colorschememapping.xml">

<style>

</style>

</head>

<body lang=EN-US style='tab-interval:.5in;word-wrap:break-word'>


Step | Description | Complete? | Comment
-- | -- | -- | --
1 | Sync appropriate branches into release branch | X |
1a | Internal branches (e.g. main dev) | X |
1b | External branches (e.g. main) | X | No external changes
2 | Run script run_all_tests.py and verify test results are appropriate | X | 10 failures, 2 warnings, 22 errors. 3 issues resolved since last release. Failures are almost wholly in search tests and known (not yet adapted) examples
2a | Run full tests | X |
2b | Regenerate badge | X |
3 | Update version numbers in appropriate files | X |
3a | Check files conf.py LICENSE.py README.py Intro_to_fmdtools.md | X |
3b | Run a repository-wide search for the version number | X |
4 | Generate the documentation using “./make html” | X | Updated docs and figures where needed. Some descriptions flagged to be updated in the future.
5 | Commit and tag branch with the appropriate version. | X | V2.0-beta2
5a | git tag -a v2.x.x -m ‘version 2.x.x’ | X |
6 | Sync to remotes | X |
6a | Push release branch to github and internal remotes | X |
6b | Overwrite documentation on gh-pages and push to GitHub | X |
7 | Create a release in GitHub | X |
7a | incorporate a narrative summary of features and changes | X |
7b | incorporate the auto-generated bitbucket release notes. | X |
9 | Update/check external CI resources as needed | X |
9a | CodeFactor | X | Update brought us from C+ to B+
10 | If release is ‘stable’ Upload to PyPI (see below | |


</body>

</html>

2.0beta1

Beta 1 Milestone: Environments, Coords, and Geoms

The beta1 milestone enables the modelling of environments using the Environment flow. Environments are CommsFlows which may be additionally be composed of two new classes:
- Coords, which enables the modelling of gridworlds
- GeomArch, which enables the modelling of maps/shapes via the newly-developed Geom, Geom

There is also additionally now a `analyze.show` module for showing these geometry classes, along with other aspects of the model which occur in 3d space (e.g., trajectories).

These classes/modules are now showcased in the (newly-refactored) multirotor model (which shows an adaptation of Coords) as well as the rover model (which shows an adaptation of GeomArch).

**Full Changelog**: https://github.com/nasa/fmdtools/compare/v2.0-beta-0.0...v2.0-beta1

v2.0-beta-0.0
Features
Some of the major features in the first -beta release include:

What's Changed
* [RAD-168] - Create DSA analyses (indicator analyses)
* [RAD-201] - Finish Adaptation of Examples
* [RAD-226] - Figure out/fix local/comms argument to Block
* [RAD-236] - Update with recordclass version
* [RAD-240] - Fix nominal_vals_2d (3d and others)
* [RAD-63] - Move tutorial to something persistently editable or viewable online
* [RAD-195] - Edit Pump Example(s) and revise Docs
* - PEP8 warnings by louwersj in https://github.com/nasa/fmdtools/pull/2
* graph.py code cleaning by louwersj in https://github.com/nasa/fmdtools/pull/7
* - plot.py cleaned import order - take note - TODO by louwersj in https://github.com/nasa/fmdtools/pull/8
* Improved search.py by louwersj in https://github.com/nasa/fmdtools/pull/9
* Update README.md by hulsed in https://github.com/nasa/fmdtools/pull/15
* Update Tank_Analysis.ipynb by ColeJetton in https://github.com/nasa/fmdtools/pull/16
* Tank and Multirotor Notebook Improvements by ColeJetton in https://github.com/nasa/fmdtools/pull/18
* Fixed Development Guide.rst hyperlinks by ColeJetton in https://github.com/nasa/fmdtools/pull/19
* Changes on MultiFlow demo and Tank_Analysis update. by ColeJetton in https://github.com/nasa/fmdtools/pull/20
* Documentation Improvement by ColeJetton in https://github.com/nasa/fmdtools/pull/21

New Contributors
* louwersj made their first contribution in https://github.com/nasa/fmdtools/pull/2
* hulsed made their first contribution in https://github.com/nasa/fmdtools/pull/15
* ColeJetton made their first contribution in https://github.com/nasa/fmdtools/pull/16

**Full Changelog**: https://github.com/nasa/fmdtools/compare/v2.0-alpha...v2.0-beta-0.0

2.0alpha

The 2.0-alpha release brings a number of high-level, far-reaching changes to the fmdtools codebase, which change how models are defined, simulated, and analyzed. As a result of all of these changes, you can expect many of the old commands and syntaxes to no longer be present--the codebase has essentially been almost completely refactored with the long-term goal of making development easier and improving the underlying interfaces/syntaxes. The major goals of the 2.0 development cycle have been to:

1. Decompose the overall model architecture into individual classes which can be documented, simulated, tested, and analyzed individually and composed in different model architectures. This has been done by creating specialized classes for `State`s, `Mode`s, `Rand`s, `Graph`s, `Result`s, `History`s, etc.
2. Replace dictionaries with [recordclass](https://bitbucket.org/intellimath/recordclass/)-based classes when possible to reduce memory usage and better enable users to define model states.
3. Refactor the overall module architecture to enable better discovery of fmdtools classes.
4. Enable the simulation, analysis, and visualization of communications and perception via specialized constructs (`MultiFlow` and `CommsFlow`).
5. Enable the simulation of indicators to track the occurrence of conditions and use them to start/end a given simulation (replacing end_conditions)

This is an `alpha` release, meaning that much of the code/tests/documentation here are not fully stable and are subject to to change. The goal of the alpha release is to show progress towards important features while enabling users to try what is here and find bugs. Expect *further updates to documentation* in the future to match all of the changes shown here.

Detailed Release Notes - Resilience Analysis and Design - Version fmdtools 2.0-alpha

<h2> Sub-task
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-184'>RAD-184</a>] - Generalize rd.graph methods
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-185'>RAD-185</a>] - add/refactor graphing methods to model constructs
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-186'>RAD-186</a>] - propositional network graphs
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-187'>RAD-187</a>] - Get graph properties from History
</li>
</ul>

<h2> Bug
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-86'>RAD-86</a>] - An error is thrown out when states are assigned lists
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-89'>RAD-89</a>] - The function type is always set to 'comms&39; when creating CommsFlow
</li>
</ul>

<h2> Epic
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-77'>RAD-77</a>] - Create modelling features for DSA research
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-170'>RAD-170</a>] - Low-level Software Engineering Improvements
</li>
</ul>

<h2> Story
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-61'>RAD-61</a>] - Unify tracking/display options with get_var syntax
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-71'>RAD-71</a>] - Create Information Flow
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-78'>RAD-78</a>] - Add ability to create propositional network from flows
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-79'>RAD-79</a>] - Add specialized comms flow type
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-80'>RAD-80</a>] - Add "Goals" to functions
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-87'>RAD-87</a>] - User feedback bugfixes/improvements
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-88'>RAD-88</a>] - Remove unnecessary sys.path calls
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-92'>RAD-92</a>] - Augment CommsFlow to enable ATC communications
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-97'>RAD-97</a>] - Enable multiple end_conditions via indicators
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-98'>RAD-98</a>] - Refactor Graphing
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-158'>RAD-158</a>] - Use __slots__/recordclass
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-161'>RAD-161</a>] - Add Model Development Guide
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-171'>RAD-171</a>] - Create and leverage base types: Parameters
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-172'>RAD-172</a>] - Refactor all modules
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-173'>RAD-173</a>] - Create and leverage base type: History
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-174'>RAD-174</a>] - Create and leverage base type: States
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-175'>RAD-175</a>] - Consolidate examples
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-179'>RAD-179</a>] - Refactor Block/FxnBlock
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-182'>RAD-182</a>] - Refactor Model
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-183'>RAD-183</a>] - Add ability to simulate FxnBlock, ASG, Block in sim.propagate
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-199'>RAD-199</a>] - Refactor and iterate on Graph Module
</li>
</ul>

<h2> Task
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-73'>RAD-73</a>] - Fix restuldisp.graph.GraphInteractor output
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-188'>RAD-188</a>] - Split readme out of docs
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-194'>RAD-194</a>] - Use Parameter in propagate
</li>
</ul>

1.3.3

Fixes a few bugs:
- process.phases now returns times of phases instead of indices (which we need when using a changeable timestep)
- plot.phases now properly scales to a given timestep dt
- SampleApproach now sorts times to sample *after* being made a list (so it doesn't get unsorted)
- Nominal history now fully copied using proc.copy_hist (rather than referenced) when needed--fixes many bugs in prop.approach where an end_condition is being used
- local component names now properly used in prop.create_single_fault_scen

Added feature:
- mdl.get_vars can now send values to dictionaries

1.3.2

- The official documentation was updated based on external feedback
- Hashable is now called from collections.abc to enable running on newer Python versions
- A major bug in fmdtools.faultsim.propagate.one_fault was fixed, where rate was not being generated from a Component or Action's probability model, but instead the containing FxnBlock.

Page 3 of 4

Releases

Has known vulnerabilities

Previous Next

Fmdtools

Page 3 of 4

2.0beta3

2.0beta2

2.0beta1

2.0alpha

1.3.3

1.3.2

Page 3 of 4

Links

Releases