Skip to content

Conversation

@john-science
Copy link
Member

@john-science john-science commented Dec 5, 2025

What is the change? Why is it being made?

Cleaning out unused code in the HistoryTrackerInterface:

  • self.time - Entirely unused in ARMI, or anywhere I can find downstream.
  • self.fullCoreLocations - Entirely unused in ARMI, or anywhere I can find downstream.
  • self.xsHistory - For the past 6 years that ARMI has existed, I can find no code that has ever WRITTEN TO this variable. I have also checked out, internal, projects that use this code, and have never seen this WRITTEN TO.
    • As such, there is a reporting tool that plots this, and every example I can find of this plot having been made in the wild... the plot is empty of data, because this is empty. So I remove the lame plot as well.
  • def _getBlockHistoryFileName(self): - Unused.
  • def _getLocationHistoryFileName(self): - Unused.
  • def filterTimeIndices(self): - Unused.

NOTE: I have tested this downstream to the best of my ability, and every test and run I could do downstream passes. I am fairly confident that these three class attributes are unused.

(Extra: I also cleaned up the docstrings and f-strings in this file. Sorry, I can't help myself.)

SCR Information

Change Type: trivial

One-Sentence Rationale: 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.

One-line Impact on Requirements: NA


Checklist

@john-science john-science added the cleanup Code/comment cleanup: Low Priority label Dec 5, 2025
@john-science john-science changed the title Cleanup history tracker 1 Cleanup HistoryTrackerInterface Dec 5, 2025
@john-science john-science changed the title Cleanup HistoryTrackerInterface Clean unused parameters from HistoryTrackerInterface Dec 5, 2025
@john-science john-science changed the title Clean unused parameters from HistoryTrackerInterface Clean unused attributes from HistoryTrackerInterface Dec 5, 2025
@john-science john-science changed the title Clean unused attributes from HistoryTrackerInterface Clean unused parts of HistoryTrackerInterface Dec 5, 2025
@john-science john-science merged commit 0e830d2 into main Dec 5, 2025
12 checks passed
@john-science john-science deleted the cleanup_history_tracker_1 branch December 5, 2025 23:09
@john-science john-science changed the title Clean unused parts of HistoryTrackerInterface Cleaning unused parts of HistoryTrackerInterface Dec 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup Code/comment cleanup: Low Priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants