This release brings two main changes to fmdtools:

1. The ability to have GeomArchitectures with Geometries that change position and shape. This is now enabled by having State values that can define properties of Geoms, rather than just Parameters.

2. More documentation of FRDL, including the incorporation of a tutorial and step-by-step run-throughs of the circuit and bread making examples

    Release Notes - Resilience Analysis and Design  - Version fmdtools 2.1.3
   

Sub-Task

• [RAD-499] - Fill out FRDL spec
• [RAD-507] - Add ability to visualize dynamic Geoms

Release Checklist

The fmdtools v.2.1.2 version includes minimal changes to the library itself, but comes with the incorporation of the Functional Reasoning Design Language (FRDL) specification as a part of the documentation repository.

Summary

fmdtools version 2.1.1 provides some minor changes to fmdtools 2.1.0, including:

• A variety of bugfixes to Coords, which use used for environmental modelling
• Added the ability to parametrically define and sample fault modes as a part of FaultDomain. The FlexibleMode class was deprecated in favor of this new workflow, and the rover model (which previously relied on FlexibleMode now uses FaultDomain instead. Overall, this workflow make models easier to define and reuse, makes the methodology easier to use and adapt, and is more computationally efficient (because the modes are only created when required for sampling, rather than at model instantiation).

Detailed changes (from commit log)

• Added publication list and updated/added publications to list
• Fixed hierarchical test such that it now sets sub_faults property on fault injection and hierarchical tests now use correct syntaxes for test
  , resolving: RAD-495
• Fixed Coords.in_area to now check arrays of points correctly, resolving RAD-490
• Fixed collection label display bug so that collection labels can now be set to true (prop label) or a custom label, resolving RAD-489
• Fixed issue with collections freezing Coords.show so that they can now plot collections without first plotting properties (no longer freezes in the process), resolving: RAD-488
• Updated coords.py so that default label for show is 'prop' rather than True
• Fixed issue with shared multiflow creation so that ultiple functions can now instantiate and use the same local flow, enabling better individual/joint simulation, resolving: RAD-485
• Added ability to parameterize fault samples so that one can now define non-default values for faults in faultdomains to sample in faultsamples. These values can be used for optional disturbances or other aspects of the faults (rates, phases, etc)
  see: RAD-491
• Added demo of parameterized fault samples in rover and tests. See RAD-491
• Replaced FlexibleMode with FaultDomain.add_fault_space method and added basic test to add_fault_space. See: RAD-496
• Adapted rover example to not use FlexibleMode so that instead of FlexibleMode, Rover now uses custom modes which are sampled with FaultDomain. Adapted rover mode notebook to match this. See: RAD-496

Release Checklist

Summary

fmdtools 2.1 is the first major point-release of fmdtools 2. As a major (breaking) release, it was primarily developed to better streamline how users work with fmdtools models based on our experience working with the library. The major changes are:

• 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: 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: v2.0.7...v2.1.0

    Release Notes - Resilience Analysis and Design  - Version fmdtools 2.1

Sub-Task

• [RAD-466] - Revise Mode to be quicker, take less memory, be more intuitive, and use dict less

Story

• [RAD-95] - Create Model Docs Views
• [RAD-472] - Update Python Setup for fmdtools 2.1
• [RAD-473] - New features for fmdtools 2.1

Release Checklist

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

Sub-Task

• [RAD-450] - Coords collections - add way of specifying more complex collections
• [RAD-456] - Provide multiplot version of Coords.show_from
• [RAD-458] - Coords.show: enable hatching (?)

Story

• [RAD-462] - Improve calculation of metrics for Result/Tabulate
• [RAD-463] - Improve Rand
• [RAD-464] - Improve Coords

Task

• [RAD-336] - Enable hierarchical modelling - with provided test

Release Checklist

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

Sub-Task

• [RAD-449] - Fix Coords/FirePropagation bug: why do we have to turn "protect" off?
• [RAD-451] - Modify get_neighbors to get corner neighbors also
• [RAD-452] - Fix rounding for grid points in Coords
• [RAD-453] - Add ability to get/cache endclass in Problems
• [RAD-455] - Add optimization plots to Problem
• [RAD-457] - show_from/plot_trajectory: provide ability to set x/y labels and titles
• [RAD-460] - Adapt BurnedMap: Add ability to plot metrics over multi-scenario results

Story

• [RAD-399] - Use somewhat safer way of passing sequences
• [RAD-444] - Fix more easy style issues
• [RAD-445] - Improve doctest coverage
• [RAD-447] - Add to requirements: matplotlib >3.7 (won't work without it)
• [RAD-454] - Lessons learned from aerialdrm (short term)
• [RAD-461] - Fix a couple docs issues

Release Checklist

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: 3c5e236). Specifically, NaNs now masked over when performing array comparisons and rands now sync effectively between architectures and environments

Full Changelog: v2.0.4...v2.0.5

Release Checklist

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

Another build to ensure desired PyPi build (2.0.0-2.0.2 haven't built properly). Reflects some changes to documentation but that's all.

Test release for PyPi. See fmdtools v2.0.0.