v2.0-rc-5
Pre-release
Pre-release
Summary
This pre-release adds the following:
- Add more features to Coords to support modelling, visualization, and animating environments
- Supporting preliminary alignment between graph plots and our FRDL specification. This effort also refactored the graph module into a subpackage to support testing and future extensions, which means that any software using these graphs will need to adjust
import
s - Add/fix some bugs identified during new modelling efforts, like making it so non-default states sent to a model continue to be used in the model and deprecating methods in Function other than static_behavior and dynamic_behavior
- Improving testing coverage
- Docs no longer tracked (which was the case prior to
2.0-rc4
- Aside from this, the
fmdtools
development environment has shifted to usingPython 3.11
. While older versions of python may still be compatible, it is recommended to update to install fmdtools in aPython 3.11
environment to remain up-to-date with our developments.
Detailed Release Notes
Release Notes - Resilience Analysis and Design - Version fmdtools 2.0-rc-5
Story
- [RAD-374] - Create the ability to overlay multiple plots in the result.plot_metric_dist ()
- [RAD-378] - Close missing testing pieces
- [RAD-403] - Troupe fmdtools feature development opportunities
- [RAD-406] - Align Graph representation with FRDL
- [RAD-410] - Remove behavior() and condfaults() from function definition
Release Checklist
<style> </style>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 | |
2 | Run script run_all_tests.py and verify test results are appropriate | x | |
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 pyproject.toml" | x | |
3b | "Run a repository-wide search for the version number" | x | |
4 | Generate the documentation using "./make html" | x | |
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 | "Push docs using git subtree push --prefix=_build/html public gh-pages " |
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 | |
8 | "Update project plan" | x | |
8a | "Include any changed dependencies" | x | |
8b | "Include version in schedule" | x | |
8c | "Identify and include additional changes/activities" | x | |
9 | Update/check external CI resources as needed | x | |
9a | "CodeFactor" | x | from 110 to 99 issues |
10 | If release is 'stable' Upload to PyPI (see below | N/A | N/A |