fmdtools version 2.0.0
This release is represents the second official release of fmdtools. The 2.0 milestone advances the overall goals of (1) extending modelling capabilities to enable the representation of human systems and distributed situation awareness in the context of systems-of-systems simulations, (2) improve the underlying modelling constructs and analysis methods to improve scalability, enable the adaptation and re-use of models, and improve the overall workflow, and (3) increase the overall maturity of the codebase. Additionally, version 2.0 is released under new license, Apache-2.0, to enable external usage and collaboration.
Compared to version 1.0, version 2.0 brings significant changes to both module organization and overall interfaces of the toolkit. If you were familiar with version 1.0, it is recommended to look through the documentation (see: https://nasa.github.io/fmdtools/).
For detailed understanding of what has changed in this development cycle, it is also recommended to review the updates for our alphas, betas and release candidates:
- https://github.com/nasa/fmdtools/releases/tag/v2.0-rc5
- https://github.com/nasa/fmdtools/releases/tag/v2.0-rc-4
- https://github.com/nasa/fmdtools/releases/tag/v2.0-rc-3
- https://github.com/nasa/fmdtools/releases/tag/v2.0-rc-2
- https://github.com/nasa/fmdtools/releases/tag/v2.0-rc-1
- https://github.com/nasa/fmdtools/releases/tag/v2.0-beta3
- https://github.com/nasa/fmdtools/releases/tag/v2.0-beta2
- https://github.com/nasa/fmdtools/releases/tag/v2.0-beta1
- https://github.com/nasa/fmdtools/releases/tag/v2.0-beta-0.0
- https://github.com/nasa/fmdtools/releases/tag/v2.0-alpha
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 | Errors from rc-6 removed |
| 2a | "Run full tests" | x | |
| 2b | "Regenerate badge" | x | |
| 3 | Update version numbers in appropriate files | x | 2.0.0 |
| 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 split --prefix=_build/html --branch gh-pages, git push -f public gh-pages git branch -D 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." | N/A | |
| 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 | 99 issues -> 71 issues |
| 10 | If release is 'stable' Upload to PyPI (see below | todo | Working on account recovery with PyPi support |