Fmdtools

Latest version: v2.1.0

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

Page 1 of 5

2.1

- [RAD-466](https://babelfish.arc.nasa.gov/jira/browse/RAD-466): A revamp of the syntax for used to define Modes. Modes are now defined in a much more intuitive syntax (adding a variable `fault_modename = (mode parameters)`) rather than the obtuse `fm_args = {'modename': (mode parameters)}` syntax used previously. This change in mode syntax (planned in the 2.0 development process) has resulted in a significant improvement in model performance--up to a *1.75x* speedup--because dictionaries of fault modes are no longer created at model instantiation from the fm_args dictionary. Instead, these modes are created and accessed when needed (e.g., to build FaultDomains, determine the set of potential faults in a function, etc.).
- [RAD-459](https://babelfish.arc.nasa.gov/jira/browse/RAD-459): A change to the syntax of `Problem` classes in search. Instead of instantiating and extending `Problem` objects, the user is now expected to define a subclass of `Problem`. The advantage of this approach is that new problems can be instantiated and sent to different algorithms and can be run with different parameters with different results and iteration histories. It also enables these problems to be more readily defined in model files and imported elsewhere (scripts, tests, etc).

While these changes should break external models, it is our intent to keep these "breaking" changes like this relatively predictable by following our major/minor release process. Both of these major changes have come with a host of adaptations to our example models (as well as bugfixes), which can be used to help determine how to migrate any dependent models you might have to the new syntaxes.

**Full Changelog**: https://github.com/nasa/fmdtools/compare/v2.0.7...v2.1.0

Release Notes - Resilience Analysis and Design - Version fmdtools 2.1

<h2> Sub-Task
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-466'>RAD-466</a>] - Revise Mode to be quicker, take less memory, be more intuitive, and use dict less
</li>
</ul>

<h2> Story
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-95'>RAD-95</a>] - Create Model Docs Views
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-472'>RAD-472</a>] - Update Python Setup for fmdtools 2.1
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-473'>RAD-473</a>] - New features for fmdtools 2.1
</li>
</ul>

**Release Checklist**

<html xmlns:v="urn:schemas-microsoft-com:vml"
xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:x="urn:schemas-microsoft-com:office:excel"
xmlns="http://www.w3.org/TR/REC-html40">

<head>

<meta name=ProgId content=Excel.Sheet>
<meta name=Generator content="Microsoft Excel 15">
<link id=Main-File rel=Main-File
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip.htm">
<link rel=File-List
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_filelist.xml">
<style>

</style>
</head>

<body link="467886" vlink="96607D">

Step | Description | Complete? | Comment
-- | -- | -- | --
1 | Sync appropriate branches into release branch using `git sync-into-dev` | x |
2 | Update version numbers in appropriate files | x |
2a | "Check files conf.py LICENSE.py README.py Intro_to_fmdtools.md pyproject.toml __init__.py" | x |
2b | "Run a repository-wide search for the version number" | x |
3 | Allow (or force) Bamboo CI to build tests and docs | x | Some fixes were required for HumanModes which have now been implemented
4 | "Release to GitHub/remotes using ``git release v2.x.x ''Version 2.x.x'' `` " | x |
5 | Create a release in GitHub
5a | "incorporate a narrative summary of features and changes" | x |
5b | "incorporate the auto-generated bitbucket release notes." | x |
6 | "Update project plan" | x | Relected in Rev Q
6a | "Include any changed dependencies" | x |
6b | "Include version in schedule" | x |
6c | "Identify and include additional changes/activities" | x |
7 | Update/check external CI resources as needed | x |
7a | "Toggle CodeFactor so it updates" | x | 46 issues -> 49 issues
7b | "Check upload to PyPi" | x |

</body>

</html>

2.1.0

Summary
-----------

2.0.7

This release brings a number of simplifications, improvements, and bugfixes, focusing on:

- Providing better functionality from Coords for representing and visualizing environments. This has been desired by internal modelling and simulation focusing on Systems-of-Systems models
- Improving overall code quality and testing coverage from Result, Rand, Coords, and FunctionArchitecture by implementing doctests in classes and methods that otherwise had no test.

This is the last point-release expected from the *2.0* series before beginning the *2.1* development, which is expected to bring a variety of changes, including incrementing Python version compatibility, along with a range of higher-impact (i.e., potentially breaking) features and improvements.

Release Notes - Resilience Analysis and Design - Version fmdtools 2.0.7

<h2> Sub-Task
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-450'>RAD-450</a>] - Coords collections - add way of specifying more complex collections
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-456'>RAD-456</a>] - Provide multiplot version of Coords.show_from
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-458'>RAD-458</a>] - Coords.show: enable hatching (?)
</li>
</ul>

<h2> Story
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-462'>RAD-462</a>] - Improve calculation of metrics for Result/Tabulate
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-463'>RAD-463</a>] - Improve Rand
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-464'>RAD-464</a>] - Improve Coords
</li>
</ul>

<h2> Task
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-336'>RAD-336</a>] - Enable hierarchical modelling - with provided test
</li>
</ul>

**Release Checklist**

<html xmlns:v="urn:schemas-microsoft-com:vml"
xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:x="urn:schemas-microsoft-com:office:excel"
xmlns="http://www.w3.org/TR/REC-html40">

<head>

<meta name=ProgId content=Excel.Sheet>
<meta name=Generator content="Microsoft Excel 15">
<link id=Main-File rel=Main-File
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip.htm">
<link rel=File-List
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_filelist.xml">
<style>

</style>
</head>

<body link="467886" vlink="96607D">

Step | Description | Complete? | Comment
-- | -- | -- | --
1 | Sync appropriate branches into release branch using `git sync-into-dev` | x |
2 | Update version numbers in appropriate files | x | Coverate now at 87.6% from 86.2%. 356 tests from 320
2a | "Check files conf.py LICENSE.py README.py Intro_to_fmdtools.md pyproject.toml __init__.py" | x |
2b | "Run a repository-wide search for the version number" | x |
3 | Allow (or force) Bamboo CI to build tests and docs | x | Test found errors to fix in optimization notebooks
4 | "Release to GitHub/remotes using ``git release v2.x.x ''Version 2.x.x'' `` " | x |
5 | Create a release in GitHub | x | Problem with Python upload - update upload-artifact to v4
5a | "incorporate a narrative summary of features and changes" | x |
5b | "incorporate the auto-generated bitbucket release notes." | x |
6 | "Update project plan" | x |
6a | "Include any changed dependencies" | x |
6b | "Include version in schedule" | x |
6c | "Identify and include additional changes/activities" | x |
7 | Update/check external CI resources as needed | x |
7a | "Toggle CodeFactor so it updates" | x | Went from 42 to 46 issues.
7b | "Check upload to PyPi" | x |

</body>

</html>

2.0.6

This release brings in a range of improvements developed over the last month, mainly focused on (1) improving Coords and environments (2) improving search capabilities and (3) improving general code quality and test metrics. Note that some interfaces for the related classes (Coords, Problems, etc) will have changed with this release.

Release Notes - Resilience Analysis and Design - Version fmdtools 2.0.6

<h2> Sub-Task
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-449'>RAD-449</a>] - Fix Coords/FirePropagation bug: why do we have to turn "protect" off?
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-451'>RAD-451</a>] - Modify get_neighbors to get corner neighbors also
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-452'>RAD-452</a>] - Fix rounding for grid points in Coords
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-453'>RAD-453</a>] - Add ability to get/cache endclass in Problems
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-455'>RAD-455</a>] - Add optimization plots to Problem
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-457'>RAD-457</a>] - show_from/plot_trajectory: provide ability to set x/y labels and titles
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-460'>RAD-460</a>] - Adapt BurnedMap: Add ability to plot metrics over multi-scenario results
</li>
</ul>

<h2> Story
</h2>
<ul>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-399'>RAD-399</a>] - Use somewhat safer way of passing sequences
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-444'>RAD-444</a>] - Fix more easy style issues
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-445'>RAD-445</a>] - Improve doctest coverage
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-447'>RAD-447</a>] - Add to requirements: matplotlib >3.7 (won't work without it)
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-454'>RAD-454</a>] - Lessons learned from aerialdrm (short term)
</li>
<li>[<a href='https://babelfish.arc.nasa.gov/jira/browse/RAD-461'>RAD-461</a>] - Fix a couple docs issues
</li>
</ul>

Release Checklist

<html xmlns:v="urn:schemas-microsoft-com:vml"
xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:x="urn:schemas-microsoft-com:office:excel"
xmlns="http://www.w3.org/TR/REC-html40">

<head>

<meta name=ProgId content=Excel.Sheet>
<meta name=Generator content="Microsoft Excel 15">
<link id=Main-File rel=Main-File
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip.htm">
<link rel=File-List
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_filelist.xml">
<style>

</style>
</head>

<body link="467886" vlink="96607D">

Step | Description | Complete? | Comment
-- | -- | -- | --
1 | Sync appropriate branches into release branch using `git sync-into-dev` | x | No outside changes
2 | Update version numbers in appropriate files | x |
2a | "Check files conf.py LICENSE.py README.py Intro_to_fmdtools.md pyproject.toml __init__.py" | x |
2b | "Run a repository-wide search for the version number" | x |
3 | Allow (or force) Bamboo CI to build tests and docs | x |
4 | "Release to GitHub/remotes using ``git release v2.x.x ''Version 2.x.x'' `` " | x |
5 | Create a release in GitHub | x |
5a | "incorporate a narrative summary of features and changes" | x |
5b | "incorporate the auto-generated bitbucket release notes." | x |
6 | "Update project plan" | x |
6a | "Include any changed dependencies" | N/A |
6b | "Include version in schedule" | x |
6c | "Identify and include additional changes/activities" | N/A |
7 | Update/check external CI resources as needed | x |
7a | "Toggle CodeFactor so it updates" | x | Went from 84 to 42 issues, attributable to RAD-444
7b | "Check upload to PyPi" | x | Version up to date

</body>

</html>

2.0.5

This release has some basic fixes to the fmdtools repo and classes:
- The documentation repository now builds as desired. This fixes an issue in 2.0.4 where sphinx did not use autodoc and automodule
- Some fixes to Coords (see: https://github.com/nasa/fmdtools/commit/3c5e2365e9e28e376329ccb14a6309d2d01ca9e1). Specifically, NaNs now masked over when performing array comparisons and rands now sync effectively between architectures and environments

**Full Changelog**: https://github.com/nasa/fmdtools/compare/v2.0.4...v2.0.5

**Release Checklist**

<html xmlns:v="urn:schemas-microsoft-com:vml"
xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:x="urn:schemas-microsoft-com:office:excel"
xmlns="http://www.w3.org/TR/REC-html40">

<head>

<meta name=ProgId content=Excel.Sheet>
<meta name=Generator content="Microsoft Excel 15">
<link id=Main-File rel=Main-File
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip.htm">
<link rel=File-List
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_filelist.xml">
<style>

</style>
</head>

<body link="467886" vlink="96607D">

Step | Description | Complete? | Comment
-- | -- | -- | --
1 | Sync appropriate branches into release branch using `git sync-into-dev` | N/A |
2 | Update version numbers in appropriate files | x |
2a | "Check files conf.py LICENSE.py README.py Intro_to_fmdtools.md pyproject.toml __init__.py" | x |
2b | "Run a repository-wide search for the version number" | x |
3 | Allow (or force) Bamboo CI to build tests and docs | x |
4 | "Release to GitHub/remotes using ``git release v2.x.x ''Version 2.x.x'' `` " | x |
5 | Create a release in GitHub | x |
5a | "incorporate a narrative summary of features and changes" | x |
5b | "incorporate the auto-generated bitbucket release notes." | x |
6 | "Update project plan" | x |
6a | "Include any changed dependencies" | N/A |
6b | "Include version in schedule" | x |
6c | "Identify and include additional changes/activities" | N/A |
7 | Update/check external CI resources as needed | x |
7a | "Toggle CodeFactor so it updates" | x | No new issues
7b | "Check upload to PyPi" | x | New programming language versions reflected

</body>

</html>

2.0.4

This version brings a few changes to fmdtools, including features, bugfixes, and development changes. These changes include:

- Adding the ability to show class inheritance as a part of ModelGraphs
- Support/use of latest version of recordclass
- Explicit support of Python 3.10, 3.11, and 3.12 (which are now all automatically tested)
- Change to the overall development process to use CI tools rather than building and testing on a developer's local machine. As a result, the development process is much more streamlined, requires much less user setup, and tests/builds should be consistent.

**Release Checklist**

<html xmlns:v="urn:schemas-microsoft-com:vml"
xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:x="urn:schemas-microsoft-com:office:excel"
xmlns="http://www.w3.org/TR/REC-html40">

<head>

<meta name=ProgId content=Excel.Sheet>
<meta name=Generator content="Microsoft Excel 15">
<link id=Main-File rel=Main-File
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip.htm">
<link rel=File-List
href="file:///C:/Users/dhulse/AppData/Local/Temp/1/msohtmlclip1/01/clip_filelist.xml">
<style>

</style>
</head>

<body link="467886" vlink="96607D">

Step | Description | Complete? | Comment
-- | -- | -- | --
1 | Sync appropriate branches into release branch using `git sync-into-dev` | x |
2 | Update version numbers in appropriate files | x |
2a | "Check files conf.py LICENSE.py README.py Intro_to_fmdtools.md pyproject.toml __init__.py" | x |
2b | "Run a repository-wide search for the version number" | x |
3 | Allow (or force) Bamboo CI to build tests and docs | x | First full run using bamboo CI for multiple tests.
4 | "Release to GitHub/remotes using ``git release v2.x.x ''Version 2.x.x'' `` " | x | Added one additional piece - support for multiple versions in toml
5 | Create a release in GitHub | x |
5a | "incorporate a narrative summary of features and changes" | x |
5b | "incorporate the auto-generated bitbucket release notes." | N/A |
6 | "Update project plan" | x |
6a | "Include any changed dependencies" | N/A |
6b | "Include version in schedule" | x |
6c | "Identify and include additional changes/activities" | Updated automated testing verbiage
7 | Update/check external CI resources as needed | x |
7a | "Toggle CodeFactor so it updates" | x | Some issues introduced due to new docs/reports folders not being ignored. Those files now added to ignore for CodeFactor.
7b | "Check upload to PyPi" | x | Now current with 2.0.4 tag (missed change in toml--will update with next release)

</body>

</html>

Page 1 of 5

Releases

Has known vulnerabilities

Fmdtools

Page 1 of 5

2.1

2.1.0

2.0.7

2.0.6

2.0.5

2.0.4

Page 1 of 5

Links

Releases