4.1. SCR for ARMI 0.6.0

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

Please note that the Software Test Report (STR) documents for all of the changes listed below will be updated as part of this release. This is a necessary part of every ARMI release, that the STRs are all updated.

Below, this SCR is organized into the individual changes that comprise the net SCR for this release.

4.1.1. SCR Listing

The following tables list all the SCRs in this release of the ARMI framework.

Code Changes, Features

Title	Change	Impact on Requirements	Author	Reviewer(s)	PR
Improving HexBlock.getFlowArea	The method HexBlock.getFlowArea() previously only accounted for regular coolant and not the inter-duct coolant.	NA	John Stilley	Casey Stocking	1995
Providing better composite iteration methods	Provide ways for users and developers to traverse the composite tree without using lists.	This very slightly simplifies the implementation I_ARMI_FLUX_COUPLING_VALUE, and very slightly touches the test T_ARMI_FLUX_COUPLING_VALUE. This also, very slightly, simplifies the implementation I_ARMI_ASSEM_DIMS1 and I_ARMI_CMP1 with the new tools this PR provides.	Drew Johnson	John Stilley	2031
Adding a check on the grid/component consistency in the BPs	Adds a check on the grids associated with a block to ensure that the components that are supposed to be in the grid actually are, and in the correct number.	This change very slightly touches the unit test T_ARMI_BP_GRID0 for the requirement R_ARMI_BP_GRID.	Chris Keckler	John Stilley	2045
Allowing ARMI to use tmp dir on Mac/Linux	Moving from the home directory to the temp direction on Linux, for ARMI temp files.	NA	John Stilley	Arrielle Opotowsky	2092
Removing support for XML geom files	Removing support for archaic XML “geom files”, in favor of modern YAML blueprint files.	NA	John Stilley	Arrielle Opotowsky	2105
Add Core.iterBlocks and Assembly.iterBlocks	Adding Core.iterBlocks and Asssembly.iterBlocks for traversing grandchildren of a Core.	A trivial implementation change to switch from getBlocks to iterBlocks in the tests for T_ARMI_MACRO_XS, T_ARMI_UMC_PARAM_BACKWARD0, T_ARMI_UMC_PARAM_BACKWARD1, T_ARMI_ROTATE_HEX_ASSEM, T_ARMI_ASSEM_BLOCKS, T_ARMI_R_SYMM, and T_ARMI_ADD_EDGE_ASSEMS.	Drew Johnson	John Stilley	2106
Handing empty string defaults better in copyInterfaceInputs	Adding logic to copyInterfaceInputs to properly handle a file setting default that is an empty string.	NA	Arrielle Opotowsky	John Stilley	2107
Store number densities in numpy arrays instead of dictionary	Change component number density storage from dictionary to numpy arrays.	NA	Michael Jarrett	John Stilley, Drew Johnson	2109
Allowing component area to be queried at arbitrary temp	Allow calculation of component area at arbitrary temperature	NA	Alex James	John Stilley	2114
Adding a FilletedHexagon shape	Adding a FilletedHexagon shape, which is just a hexagon with rounded corners.	NA	John Stilley	dlangewisch, Chris Keckler, Alex James	2118
Supporting growing DBto full core on db load	The setting growToFullCoreAfterLoad is used to expand the reactor to full core when loading from a database.	Functionality added to I_ARMI_DB_TIME1 the implementation of R_ARMI_DB_TIME	Drew Johnson	John Stilley	2121
Retooling single-warnings report as all warnings report	Retooling the old de-duplicated-warnings-report with a new all-warnings-report.	Trivial tweaks of I_ARMI_LOG_MPI for R_ARMI_LOG_MPI. Improving test T_ARMI_LOG2 for R_ARMI_LOG.	John Stilley	Tony Alberti, Arrielle Opotowsky	2135
Allowing the BOL orientations to be set in the blueprints	Allowing the BOL orientations to be set in the blueprints	NA	John Stilley	Alex James, Chris Keckler	2138
Make axial linking aware of block grids for axial expansion	Enable multi-pin component support for axial expansion.	N/A	Tony Alberti	Drew Johnson, John Stilley, Chris Keckler	2145
Improving Core.libs to look for the current cycle and node	Improving Core.libs to look for the current cycle and node.	NA	John Stilley	Arrielle Opotowsky, Mark Onufer	2173
Blocking duplicate flags from being added	Blocking duplicate flags from being added.	Changes the implementation I_ARMI_FLAG_EXTEND0 of R_ARMI_FLAG_EXTEND, so that if someone tries to add a flag that already exists, it is silently ignored.	John Stilley	Alex James	2175

Code Changes, Bugs and Fixes

Title	Change	Impact on Requirements	Author	Reviewer(s)	PR
Fixing a couple of plots to use initial block height	Fixing a couple of plots to use initial block heightt.	NA: None of these plots of requirements.	John Stilley	Chris Keckler, Drew Johnson	1998
Removing the HTML reports feature	The ARMI HTML reports were never used, and they are currently broken, so they are being removed.	NA	John Stilley	Tony Alberti	2098
Fixing issue in copyInterfaceInputs with one file	This fixes an edge case in copyInterfaceInputs() where there is a list of files to copy, but the list is only one element long.	NA	John Stilley	Drew Johnson	2102
fix side effects from tests	Fix unintended unit test side effects.	NA	Alex James	John Stilley	2111
Adding Reactor construction hook to Database.load()	Add beforeReactorConstruction hook to database loads.	NA	Alex James	John Stilley, Arrielle Opotowsky	2115
OperatorMPI doesn’t need to bcast quits if there no other workers	Allow OperatorSnaphots.operate work with without optional mpi4py dependency.	NA	Drew Johnson	John Stilley	2129
Hiding duplicate warning messages	Hiding duplicate warning messages.	NA	John Stilley	Michael Jarrett	2153
Fixing bad Return in safeCopy	Fixing the method safeCopy() there was an invalid keyword Return, which should have been return.	This is a low-level file system tool and could technically affect lots of unit tests by making them fail. But the only requirement that is directly affected is R_ARMI_XSGM_FREQ because safeCopy is used in the implementation of I_ARMI_XSGM_FREQ3.	John Stilley	Aaron Reynolds, Arrielle Opotowsky	2160
Using gamma groups instead of neutron groups in gamiso.addDummyNuclidesToLibrary	TBD	NA	Arrielle Opotowsky	John Stilley, Aaron Reynolds	2163
Using np.int32 when reading GEODST files	Use a numpy.int32 when reading GEODST files.	R_ARMI_NUCDATA_GEODST holds the requirement to read a GEODST file.	Drew Johnson	John Stilley	2176
Remove assert statements from FilletedHexagon instantiation.	TBD	NA	Michael Jarrett	John Stilley	2180

Code Changes, Maintenance, or Trivial

Title	Change	Impact on Requirements	Author	Reviewer(s)	PR
Improve “smallRun” settings names	Changing the names of some rarely used settings to be more explicit and useful	NA	Tony Alberti	John Stilley	1386
Dropping black formatter for ruff	I dropped the black linter from the project and switched to using ruff.	Many requirements will be touched in a very trivial way: their whitespace may change very slightly.	John Stilley	Nick Touran, Arrielle Opotowsky	2085
Speed up axial expansion unit tests	Speeding up unit tests related to axial expansion.	Very minor change to the tests associated with T_ARMI_ASSEM_HEIGHT_PRES and T_ARMI_INP_COLD_HEIGHT, in that I have sped them up.	John Stilley	Tony Alberti	2093
Fixing spelling errors	Fixing spelling errors found throughout the documentation and code comments.	NA	John Stilley	jabari-max, Arrielle Opotowsky	2096
Fixing spelling in docs and docstrings	Fixing spelling errors in the ARMI docs and docstrings.	NA	John Stilley	Tony Alberti	2103
Removing defunct references to Cinder	Remove references to an internally deprecated tool Cinder.	N/A	Tony Alberti	John Stilley	2104
Combining three .gitignore files into one	Cleanup: I am combining three .gitignore files into one.	NA	John Stilley	Tony Alberti	2110
Cleaning up the codeTiming reports	Cleaning up the codeTiming reports.	NA	John Stilley	Tony Alberti, Arrielle Opotowsky	2116
Reducing the warnings from Block.autoCreateSpatialGrids	Reducing the warnings from Block.autoCreateSpatialGrids	NA	John Stilley	Drew Johnson, Chris Keckler	2117
Removing permanently skipped tests	Removing permanently skipped tests.	NA	John Stilley	Arrielle Opotowsky	2123
Removing old TODO comments from the codebase	Removing old TODO comments from the codebase	NA	John Stilley	Arrielle Opotowsky	2126
Removing 3 unused Settings	Removing 3 unused Settings: customFuelManagementIndex, infiniteDiluteCutoff, and lowPowerRegionFraction.	NA	John Stilley	Tony Alberti	2127
Created a fast flux energy structure for calculating fast flux	This change adds a new energy structure to be used by an application to calculate the fast flux fraction.	NA	Tommy Cisneros	John Stilley	2128
Removing unused Parameters	We identified several parameters which were totally unused, and removed them.	NA	John Stilley	Tony Alberti	2130
Removing unused reactivity coeffs params	Removing unused reactivity coefficients parameters.	NA	John Stilley	Tony Alberti	2132
Moving NeutronicsPlugin to its own file	Moving NeutronicsPlugin to its own file.	NA	John Stilley	Tony Alberti	2133
Removing unused Parameters	Removing unused parameters, particularly relating to depletion and equilibrium.	NA	John Stilley	Arrielle Opotowsky, Tony Alberti	2134
Removing unused TH parameters.	Removing unused thermal hydraulics parameters.	NA	John Stilley	Arrielle Opotowsky	2136
Removing unnecessary DB load try/except	Removing unnecessary DB load try/except	Hypothetically, this touches I_ARMI_DB_TIME1. However, all we are doing here is removing unused code. So there will be no noticeable effect.	John Stilley	Arrielle Opotowsky	2139
Cleaning up Block constructor	Removing old, defunct code from Block constructor.	NA	John Stilley	Arrielle Opotowsky	2140
Changing format-style strings to f-strings	Swapping out old format-based strings with f-strings.	NA	Tony Alberti	John Stilley	2141
Quieting warnings from Block.getComponent	Reducing warning output from getComponent	None	Alex James	John Stilley	2142
Improving the default value for Assembly.getArea()	Improving the default value for Assembly.getArea()	NA	John Stilley	Tony Alberti, Arrielle Opotowsky	2144
Some more fstring conversions	Swapping out old format-based strings with f-strings.	NA	Tony Alberti	John Stilley	2146
Cleaning up strange counter line	Cleaning out a strange counter increment in the plugin manager.	NA	John Stilley	Arrielle Opotowsky	2155
Removing overly-specific check from the Component constructor	Removing overly-specific check from the Component constructor.	We are removing code we don’t like from I_ARMI_COMP_DEF, which implements R_ARMI_COMP_DEF. But this is a very minor clean-up type change. That feature will remain unchanged in practice.	John Stilley	Chris Keckler	2157
Removing old setting mpiTasksPerNode from ZPPR test file	Removing old setting mpiTasksPerNode from ZPPR test file.	NA	John Stilley	Chris Keckler	2165
Removing commented out code	Removing code that was commented out.	NA	John Stilley	Tony Alberti	2166
Removing unused test code	Cleaning out unused test code.	NA	Tony Alberti	John Stilley	2167
Removing Deprecation Warning on sortReactor setting	Removing Deprecation Warning on sortReactor setting.	NA	John Stilley	Chris Keckler	2168
Adding a collar flag	Adding a new flag for assemblies: COLLAR.	NA	John Stilley	jyang-TP, Arrielle Opotowsky	2170
Cleaning up Tests to have Fewer Side Effects	Cleaning up a couple tests to have fewer side effects, so they can be run in any order.	None	Alex James	John Stilley	2171

Documentation-Only Changes

Title	Change	Impact on Requirements	Author	Reviewer(s)	PR
Adding an SCR section to the docs	ARMI now has an automated “SCR” section, instead of a manual “Release Notes” section that has to be tweaked in code.	NA	John Stilley	Arrielle Opotowsky	2090
Edits to STR test report	Several changes to the Software Test Report, to improve legibility.	NA	Arrielle Opotowsky	John Stilley	2095
Adding more info to STR intro	Clarifying how ARMI requirements are met with unit tests.	NA	John Stilley	Arrielle Opotowsky	2100
Fixing issue with SCR on main branch	Fixing an issue where the SCR is not generating correctly on the main branch, only on PRs.	NA	John Stilley	Arrielle Opotowsky	2101
Adding basic documentation for axial expansion	Adding basic documentation for axial expansion	NA	John Stilley	Tony Alberti, Chris Keckler	2119
Update docstring for Settings class to reflect mutability	Update the docstring for the Settings class to reflect their mutability	None	Chris Keckler	John Stilley	2131
Improving description of rateProdNet parameter	Improving descriptiion of rateProdNet parameter,	NA	John Stilley	Drew Johnson	2137
Improving the docs-build instructions	Improving the docs-build instructions	NA	John Stilley	Tony Alberti	2143
Adding tooling to help people build the docs locally	Adding tooling so that people can more easily build the docs locally.	NA	John Stilley	Arrielle Opotowsky, Tony Alberti	2148
Clarifying setting disableBlockTypeExclusionInXsGeneration	Clarifying the setting disableBlockTypeExclusionInXsGeneration.	NA	John Stilley	Drew Johnson	2150
Adding SQA for the SFP and cycles setting	Adding SQA for the SpentFuelPool and the setting “cycles”.	Added the requirement R_ARMI_SFP to cover the SpentFuelPool feature. And added more testing of the “cycles” setting to R_ARMI_FW_HISTORY.	John Stilley	Chris Keckler	2151
Remove traces of black	Ensuring the software attributes in the ARMI docs are up to date with current practices.	NA	Tony Alberti	John Stilley	2174