4.1. SCR for ARMI 0.6.1

This is a listing of all the Software Change Request (SCR) changes in the ARMI repository, as part of release number 0.6.1.

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 #2303: Encapsulating global nuclide data in classes

    • Change: Making classes to contain the global data in nuclideBases.py and elements.py.

    • Impact on Requirements: The code related to nuclideBases and elements is being refactored to be more contained: I_ARMI_ND_ELEMENTS0, I_ARMI_ND_ELEMENTS1, I_ARMI_ND_DATA0, I_ARMI_ND_DATA1, I_ARMI_ND_ISOTOPES0, I_ARMI_ND_ISOTOPES1, I_ARMI_ND_ISOTOPES2, I_ARMI_ND_ISOTOPES3, I_ARMI_ND_ISOTOPES4, I_ARMI_ND_ISOTOPES5, I_ARMI_ND_ISOTOPES6, and I_ARMI_ND_ISOTOPES7 for R_ARMI_ND_ELEMENTS, R_ARMI_ND_DATA, and R_ARMI_ND_ISOTOPES.

    • Author: John Stilley

    • Reviewer(s): Drew Johnson, Arrielle Opotowsky

  • PR #2317: Simplify thermal scattering

    • Change: Simplifying the API and architecture for the old thermal scattering laws.

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Drew Johnson

  • PR #2320: Providing interface method interactRestart for managing restarts

    • Change: Provide interactRestart interface method for managing restarts

    • Impact on Requirements: R_ARMI_SNAPSHOT_RESTART implementation is modified to use this new behavior

    • Author: Drew Johnson

    • Reviewer: John Stilley

  • PR #2321: Adding Core.hasLib to check if there is a XS library

    • Change: Provide Core.hasLib to check if there is a cross section library

    • Impact on Requirements: NA

    • Author: Drew Johnson

    • Reviewer: John Stilley

  • PR #2323: Enabling user-specified distribution of MPI actions across nodes

    • Change: Provide a new method to allow user to specify the distribution of MPI actions across nodes.

    • Impact on Requirements: NA

    • Author: Michael Jarrett

    • Reviewer(s): John Stilley, Arrielle Opotowsky

  • PR #2324: Adding orientationBOL to full core modifier

    • Change: Ensure beginning of life orientations are expanded to full core by the FullCoreModifier.

    • Impact on Requirements: None

    • Author: Alex James

    • Reviewer: John Stilley

  • PR #2325: Creating a new setting to specify memory requirement for cross section calculation

    • Change: Add a setting to the crossSectionControl dictionary to mark the memory requirements for each cross section type.

    • Impact on Requirements: NA

    • Author: Michael Jarrett

    • Reviewer(s): John Stilley, Arrielle Opotowsky

  • PR #2344: Changing default for guideTubeTopElevation to zero

    • Change: Changing default for guideTubeTopElevation to zero

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Drew Johnson

List of SCRs of type: Code Changes, Bugs and Fixes

  • PR #2328: Ensuring that users define isotopics for custom materials

    • Change: Ensuring that users define isotopics for custom materials

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Chris Keckler

  • PR #2331: Resolve TEST_ROOT path

    • Change: Process TEST_ROOT so that the path string for a test case will resolve to match ARMI_RUN_PATH for test reactor pickeling.

    • Impact on Requirements: NA

    • Author: Arrielle Opotowsky

    • Reviewer(s): Chris Wong, John Stilley

  • PR #2336: Checking number of jobs against available ranks in runBatchedActions

    • Change: Add an error check for invalid user grouping of MPI tasks across nodes.

    • Impact on Requirements: NA

    • Author: Michael Jarrett

    • Reviewer: John Stilley

  • PR #2347: Fixing missing f-string in component blueprints

    • Change: Fixing missing f-string in component blueprints.

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Chris Keckler

  • PR #2350: Fixing compareLines for a multiple numbers edge case

    • Change: If a line has multiple numbers on it, ALL the numbers must be equal for compareLines() to return True.

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer(s): Chris Keckler, Chris Wong

List of SCRs of type: Code Changes, Maintenance, or Trivial

  • PR #2306: Removing volume from getMgFlux()

    • Change: Removing volume from getMgFlux()

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Arrielle Opotowsky

  • PR #2309: Moving plotting functions into utils module

    • Change: Moving all the remaining plotting functions into the utils module.

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Arrielle Opotowsky

  • PR #2310: Removing unnecessary code from Assembly.getBlocksBetweenElevations

    • Change: Removing unnecessary code from Assembly.getBlocksBetweenElevations.

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Chris Keckler

  • PR #2315: Moving some testing utils to testing module

    • Change: Refactor some testing utils to use testing module

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Arrielle Opotowsky

  • PR #2327: Adding a unit test to HexGrid.generateSortedHexLocationList

    • Change: Adding a unit test to HexGrid.generateSortedHexLocationList.

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Arrielle Opotowsky

  • PR #2348: Make singleMixedAssembly more flexible for downstream testing

    • Change: Improve testing flexibility.

    • Impact on Requirements: NA

    • Author: Tony Alberti

    • Reviewer: John Stilley

  • PR #2358: Adding code coverage

    • Change: Adding code coverage.

    • 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

List of SCRs of type: Documentation-Only Changes

  • PR #2250: Logging redundant material modifications

    • Change: Logging redundant material modifications.

    • Impact on Requirements: Trivial logging change to I_ARMI_BP_COMP for R_ARMI_BP_COMP.

    • Author: John Stilley

    • Reviewer: Chris Keckler

  • PR #2280: Improving the new shuffling docs

    • Change: Fix a few minor things in the docs for assembly shuffling.

    • Impact on Requirements: NA

    • Author: Chris Keckler

    • Reviewer(s): John Stilley, Drew Johnson

  • PR #2311: Starting the ARMI 0.6.1 release cycle

    • Change: Starting the ARMI 0.6.1 release cycle.

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer(s): Drew Johnson, Arrielle Opotowsky

  • PR #2312: Updating XS group manager requirements

    • Change: Update requirements and test tags for cross section group manager.

    • Impact on Requirements: Update description for R_ARMI_XSGM_CREATE_REPR_BLOCKS and R_ARMI_XSGM_CREATE_XS_GROUPS.

    • Author: Michael Jarrett

    • Reviewer(s): Tony Alberti, John Stilley

  • PR #2314: Documenting ARMI’s testing tools for devs

    • Change: Documenting ARMI’s testing tools for devs

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Arrielle Opotowsky

  • PR #2332: Adding settings header to the settings YAML

    • Change: Adding settings header to the settings YAML.

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Arrielle Opotowsky

  • PR #2337: Trying to fix docs

    • Change: Trying to fix docs

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer(s): Arrielle Opotowsky, Tony Alberti

  • PR #2339: Adding contributor to SCR doc automation script

    • Change: Adding ARMI contributor to the SCR automation script.

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Arrielle Opotowsky

  • PR #2342: Documenting how to use the zonesFile Setting

    • Change: Documenting how to use the zonesFile Setting.

    • Impact on Requirements: Documentation around the R_ARMI_ZONE functionality

    • Author: Drew Johnson

    • Reviewer: John Stilley

  • PR #2343: Improving documentation for zoneDefinions setting

    • Change: Improving documentation for zoneDefinions setting

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Drew Johnson

  • PR #2354: Clarifying that ARMI materials are of testing quality

    • Change: It is important to ensure that downstream users understand that ARMI materials are not of production quality, and ARMI is a modeling framework not a data source.

    • Impact on Requirements: NA

    • Author: John Stilley

    • Reviewer: Arrielle Opotowsky