4.1. SCR for ARMI 0.6.2
This is a listing of all the Software Change Request (SCR) changes in the ARMI repository, as part of release number 0.6.2.
Below, this SCR is organized into the individual changes that comprise the net SCR for this release. Each SCR below explicitly lists its impact on ARMI requirements, if any. It is also important to note ARMI and all its requirements are tested entirely by the automated testing that happens during the ARMI build. None of the SCRs below will be allowed to happen if any single test fails, so it can be guaranteed that all SCRs below have fully passed all testing.
4.1.1. SCR Listing
The following lists display all the SCRs in this release of the ARMI framework.
List of SCRs of type: Code Changes, Features
PR #2335: Moving to use Reactor.nuclideBases, where possible
Change: This is part of the push to eventually get rid of global nuclides.
Impact on Requirements: I_ARMI_ND_ELEMENTS0 for R_ARMI_ND_ELEMENTS0 is being rewritten to be less global. All implementation tags for R_ARMI_ND_ISOTOPES should be considered touched, as we are rewriting that code to be less global. Touched I_ARMI_R because we added a property to the Reactor class. Minor tweak to T_ARMI_UTIL_EXP_MASS_FRACS, but no meaningful change.
Author: John Stilley
Reviewer: Arrielle Opotowsky
List of SCRs of type: Code Changes, Bugs and Fixes
PR #2364: Fixing HoledHexagon.holeRadFromCenter type
Change: The default type of this parameter should be float and not int.
Impact on Requirements: NA
Author: John Stilley
Reviewer: Nicole Powell
List of SCRs of type: Code Changes, Maintenance, or Trivial
PR #2177: Changing Interface.function to Interface.purpose
Change: The word “function” is already an important term in the Python language, and this is confusing.
Impact on Requirements: Minor edit to the implementation I_ARMI_INTERFACE on the requirement R_ARMI_INTERFACE
Author: John Stilley
Reviewer(s): Chris Keckler, Arrielle Opotowsky, Drew Johnson
PR #2334: Refactoring loadTestReactor to pickle multiple test reactors
Change: This substantially decreases unit testing time.
Impact on Requirements: NA
Author: John Stilley
Reviewer: Arrielle Opotowsky
PR #2358: Adding code coverage
Change: We don’t want uncovered code in our codebase.
Impact on Requirements: NA
Author: John Stilley
Reviewer: Arrielle Opotowsky
PR #2359: Cleaning up DB version logic
Change: I thought the DB version logic was muddled and there were some broken code snippets.
Impact on Requirements: A minor change to I_ARMI_DB_H51 for R_ARMI_DB_H5, as we removed some unused code and put better error-handling on what remains.
Author: John Stilley
Reviewer: Arrielle Opotowsky
PR #2360: Cleaning out broken tryPickleOnAllContents3
Change: This feature appears to me to be broken, so I am removing it.
Impact on Requirements: NA
Author: John Stilley
Reviewer: Arrielle Opotowsky
PR #2366: Raising instead of returning errors
Change: The exceptions in Python are meant to be raised, not returned, in most cases.
Impact on Requirements: NA
Author: John Stilley
Reviewer: Arrielle Opotowsky
PR #2369: Moving three test reactors to the testing module
Change: We want the test data that ARMI provides to be better organized, for our downstream users.
Impact on Requirements: NA
Author: John Stilley
Reviewer: Arrielle Opotowsky
PR #2371: Moving more ARMI testing tools to the testing module
Change: We would like to create an armi.testing module with a small set of high-quality testing tools.
Impact on Requirements: NA
Author: John Stilley
Reviewer: Arrielle Opotowsky
PR #2375: Cleaning unused parts of HistoryTrackerInterface
Change: The HistoryTrackerInterface has not gotten a lot of love in the past few years, so this is the start of an effort to clean it up and simplify it.
Impact on Requirements: NA
Author: John Stilley
Reviewer: Arrielle Opotowsky
List of SCRs of type: Documentation-Only Changes
PR #2351: Updating PR form to use the word Rationale
Change: To improve the documentation of each PR, when it becomes an SCR.
Impact on Requirements: NA
Author: John Stilley
Reviewer: Arrielle Opotowsky
PR #2363: Starting 0.6.2 release cycle
Change: These changes are necessary for the automated SCR script to keep ARMI’s rolling SQA working.
Impact on Requirements: NA
Author: John Stilley
Reviewer(s): Drew Johnson, Tony Alberti, Arrielle Opotowsky
PR #2365: Improving and correcting the ARMI version semantics
Change: It has been noted that the version semantics in the ARMI docs did not match the reality of the ARMI releases.
Impact on Requirements: NA
Author: John Stilley
Reviewer(s): Drew Johnson, Arrielle Opotowsky
PR #2367: Formatting code in docstrings
Change: The example Python code in our docs should follow the same formatting and linting rules as the rest of the codebase.
Impact on Requirements: NA
Author: John Stilley
Reviewer: Arrielle Opotowsky