Reinstate case summary when initing Operator (#28)

This also teaches it how to probe interfaces for their inputs and track
yaml !includes

armi/bookkeeping/report/reportingUtils.py

@@ -19,6 +19,7 @@
 import re
 import os
 import collections
+import pathlib
 import textwrap
 import sys
 import time
@@ -33,6 +34,8 @@
 from armi.utils import iterables
 from armi.utils import units
 from armi.utils import pathTools
+from armi.utils import textProcessors
+from armi import interfaces
 from armi.bookkeeping import report
 from armi.reactor.flags import Flags
 from armi.reactor.components import ComponentType
@@ -60,7 +63,7 @@ def _writeCaseInformation(o, cs):
                 "{} - {}".format(cs["runType"], o.__class__.__name__),
             ),
             (strings.Operator_CurrentUser, armi.USER),
-            (strings.Operator_ArmiCodebase, cs["armiLocation"]),
+            (strings.Operator_ArmiCodebase, armi.ROOT),
             (strings.Operator_WorkingDirectory, os.getcwd()),
             (strings.Operator_PythonInterperter, sys.version),
             (strings.Operator_MasterMachine, os.environ.get("COMPUTERNAME", "?")),
@@ -75,24 +78,43 @@ def _writeCaseInformation(o, cs):
     def _listInputFiles(cs):
         """
         Gathers information about the input files of this case.
-    
+
         Returns
         -------
         inputInfo : list
             (label, fileName, shaHash) tuples
         """
+
+        pathToLoading = pathlib.Path(cs.inputDirectory) / cs["loadingFile"]
+
+        if pathToLoading.is_file():
+            includedBlueprints = [
+                inclusion[0]
+                for inclusion in textProcessors.findYamlInclusions(pathToLoading)
+            ]
+        else:
+            includedBlueprints = []
+
         inputInfo = []
-        inputFiles = [
-            ("Case Settings", cs.caseTitle + ".yaml"),
-            ("Blueprints", cs["loadingFile"]),
-            ("Geometry", cs["geomFile"]),
-        ]
-        if cs["shuffleLogic"]:
-            inputFiles.append(("Fuel Management", cs["shuffleLogic"]))
-        if cs["controlLogic"]:
-            inputFiles.append(("Control Logic", cs["controlLogic"]))
-        if cs["orificeSettingsFile"]:
-            inputFiles.append(("Orifice Settings", cs["orificeSettingsFile"]))
+        inputFiles = (
+            [
+                ("Case Settings", cs.caseTitle + ".yaml"),
+                ("Blueprints", cs["loadingFile"]),
+            ]
+            + [("Included blueprints", inclBp) for inclBp in includedBlueprints]
+            + [("Geometry", cs["geomFile"])]
+        )
+
+        activeInterfaces = interfaces.getActiveInterfaceInfo(cs)
+        for klass, kwargs in activeInterfaces:
+            if not kwargs.get("enabled", True):
+                # Don't consider disabled interfaces
+                continue
+            interfaceFileNames = klass.specifyInputs(cs)
+            for label, fileNames in interfaceFileNames.items():
+                for fName in fileNames:
+                    inputFiles.append((label, fName))
+
         if cs["reloadDBName"] and cs["runType"] == RunTypes.SNAPSHOTS:
             inputFiles.append(("Database", cs["reloadDBName"]))
         for label, fName in inputFiles:
@@ -166,10 +188,6 @@ def _writeReactorCycleInformation(o, cs):
     if armi.MPI_RANK > 0:
         return  # prevent the worker nodes from printing the same thing
 
-    #  make sure armiLocation is consistent with what's truly running.
-    if os.path.join(cs["armiLocation"], "armi") != armi.ROOT:
-        warnings.Operator_executionScriptDiffersFromArmiLocation(armi.ROOT)
-
     _writeCaseInformation(o, cs)
     _writeInputFileInformation(cs)
     _writeMachineInformation()

armi/interfaces.py

@@ -442,7 +442,12 @@ def specifyInputs(cs) -> Dict[str, List[str]]:  # pylint: disable=unused-argumen
 
         The files returned by an implementation of this method are those that one would
         want copied to a remote location when cloning a Case or CaseSuite to a remote
-        location
+        location.
+
+        Note
+        ----
+        This existed before the advent of ARMI plugins. Perhaps it can be better served
+        as a plugin hook. Potential future work.
 
         Parameters
         ----------

armi/operators/operator.py

@@ -104,6 +104,9 @@ def __init__(self, cs):
         self.powerFractions = self._getPowerFractions()
         self._checkReactorCycleAttrs()
 
+        # Create the welcome headers for the case (case, input, machine, and some basic reactor information)
+        reportingUtils.writeWelcomeHeaders(self, cs)
+
     def _getCycleLengths(self):
         """Return the cycle length for each cycle of the system as a list."""
         return utils.expandRepeatedFloats(self.cs["cycleLengths"]) or (