refactor(com1DFA): improve code readability and fix logging messages; comments AW

- Introduced a deep copy for `com1DFA` configuration to prevent unintended mutations
- `getModuleConfig` priority documentation and logic handling
- Added warning for ignored friction calibration in expert mode

Author: fso42

avaframe/com3Hybrid/com3Hybrid.py

@@ -78,15 +78,16 @@ def maincom3Hybrid(cfgMain, cfgHybrid):
     iterate = True
     resultsHybrid = {}
     while iteration < nIterMax and iterate:
-        # update the com1DFA mu value directly in ConfigParser
-        com1DFACfg['GENERAL']['mucoulomb'] = '%.4f' % muArray[-1]
+        # create a copy to avoid com1DFAMain modifying the original config
+        com1DFACfgCopy = copy.deepcopy(com1DFACfg)
+        com1DFACfgCopy['GENERAL']['mucoulomb'] = '%.4f' % muArray[-1]
 
         log.info('Mu is set to: %f' % muArray[-1])
         # ++++++++++ RUN COM1DFA +++++++++++
         # Run dense flow with coulomb friction
         # Clean input directory of old work and output files from module
         initProj.cleanModuleFiles(avalancheDir, com1DFA, deleteOutput=False)
-        dem, _, _, simDF = com1DFA.com1DFAMain(cfgMain, cfgInfo=com1DFACfg)
+        dem, _, _, simDF = com1DFA.com1DFAMain(cfgMain, cfgInfo=com1DFACfgCopy)
         simID = simDF.index[0]
         particlesList, timeStepInfo = particleTools.readPartFromPickle(avalancheDir, simName=simID, flagAvaDir=True,
                                                                        comModule='com1DFA')
@@ -135,7 +136,7 @@ def maincom3Hybrid(cfgMain, cfgHybrid):
         iteration = iteration + 1
 
     # write final com1DFA configuration to file for documentation
-    cfgUtils.writeCfgFile(avalancheDir, com1DFA, com1DFACfg, fileName='com1DFA_settings',
+    cfgUtils.writeCfgFile(avalancheDir, com1DFA, com1DFACfgCopy, fileName='com1DFA_settings',
                           filePath=workPath)
 
     # fetch fields for desired time step

avaframe/in3Utils/cfgUtils.py

@@ -95,10 +95,16 @@ def getGeneralConfig(nameFile=""):
     return cfg
 
 
-def getModuleConfig(module, avalancheDir="", fileOverride="", batchCfgDir="", modInfo=False, toPrint=True, onlyDefault=False):
+def getModuleConfig(
+    module, avalancheDir="", fileOverride="", batchCfgDir="", modInfo=False, toPrint=True, onlyDefault=False
+):
     """Returns the configuration for a given module
     returns a configParser object OR pathlib.Path (when batchCfgDir is used)
 
+    Priority order:
+        batchCfgDir (returns Path) -> onlyDefault -> fileOverride -> expert config (CFGs/) ->
+        local_MODULECfg.ini -> MODULECfg.ini
+
     Parameters
     ----------
     module : module object or pathlib.Path
@@ -132,8 +138,6 @@ def getModuleConfig(module, avalancheDir="", fileOverride="", batchCfgDir="", mo
         ConfigParser object with merged configuration, OR
         pathlib.Path when batchCfgDir is provided
 
-    Priority order:
-        batchCfgDir (returns Path) -> fileOverride -> expert config (CFGs/) -> local_MODULECfg.ini -> MODULECfg.ini
 
     """
     if isinstance(onlyDefault, bool) == False:

avaframe/runCom1DFA.py

@@ -1,6 +1,7 @@
 """
-    Run script for running python com1DFA kernel
+Run script for running python com1DFA kernel
 """
+
 # Load modules
 # importing general python modules
 import time
@@ -16,8 +17,9 @@
 from avaframe.in3Utils import logUtils
 from avaframe.in3Utils import fileHandlerUtils as fU
 
-def runCom1DFA(avalancheDir='', calibration=''):
-    """ Run com1DFA in the default configuration with only an
+
+def runCom1DFA(avalancheDir="", calibration=""):
+    """Run com1DFA in the default configuration with only an
     avalanche directory as input and the (optional) friction calibration
     size
 
@@ -38,21 +40,21 @@ def runCom1DFA(avalancheDir='', calibration=''):
     startTime = time.time()
 
     # log file name; leave empty to use default runLog.log
-    logName = 'runCom1DFA'
+    logName = "runCom1DFA"
 
     # Load avalanche directory from general configuration file
     # More information about the configuration can be found here
     # on the Configuration page in the documentation
     cfgMain = cfgUtils.getGeneralConfig()
-    if avalancheDir != '':
-        cfgMain['MAIN']['avalancheDir'] = avalancheDir
+    if avalancheDir != "":
+        cfgMain["MAIN"]["avalancheDir"] = avalancheDir
     else:
-        avalancheDir = cfgMain['MAIN']['avalancheDir']
+        avalancheDir = cfgMain["MAIN"]["avalancheDir"]
 
     # Start logging
     log = logUtils.initiateLogger(avalancheDir, logName)
-    log.info('MAIN SCRIPT')
-    log.info('Current avalanche: %s', avalancheDir)
+    log.info("MAIN SCRIPT")
+    log.info("Current avalanche: %s", avalancheDir)
 
     # ----------------
     # Clean input directory(ies) of old work and output files
@@ -63,42 +65,50 @@ def runCom1DFA(avalancheDir='', calibration=''):
     # Set friction model according to cmd argument
     cfgCom1DFA = cfgUtils.getModuleConfig(com1DFA, avalancheDir, toPrint=False)
 
-    if calibration.lower() == 'small':
-        cfgCom1DFA['GENERAL']['frictModel'] = 'samosATSmall'
-    elif calibration.lower() == 'medium':
-        cfgCom1DFA['GENERAL']['frictModel'] = 'samosATMedium'
-    elif calibration.lower() == 'large':
-        cfgCom1DFA['GENERAL']['frictModel'] = 'samosAT'
-    elif calibration.lower() == 'auto':
-        cfgCom1DFA['GENERAL']['frictModel'] = 'samosATAuto'
+    if isinstance(cfgCom1DFA, pathlib.Path):
+        log.warning("Expert mode detected - friction calibration override is ignored")
+    elif calibration.lower() == "small":
+        cfgCom1DFA["GENERAL"]["frictModel"] = "samosATSmall"
+    elif calibration.lower() == "medium":
+        cfgCom1DFA["GENERAL"]["frictModel"] = "samosATMedium"
+    elif calibration.lower() == "large":
+        cfgCom1DFA["GENERAL"]["frictModel"] = "samosAT"
+    elif calibration.lower() == "auto":
+        cfgCom1DFA["GENERAL"]["frictModel"] = "samosATAuto"
     else:
-        log.info('no friction calibration override given - using ini')
+        log.info("no friction calibration override given - using ini")
 
     # ----------------
     # Run dense flow
     dem, plotDict, reportDictList, simDF = com1DFA.com1DFAMain(cfgMain, cfgInfo=cfgCom1DFA)
 
     # Get peakfiles to return to QGIS
     avaDir = pathlib.Path(avalancheDir)
-    inputDir = avaDir / 'Outputs' / 'com1DFA' / 'peakFiles'
+    inputDir = avaDir / "Outputs" / "com1DFA" / "peakFiles"
     peakFilesDF = fU.makeSimDF(inputDir, avaDir=avaDir)
 
     # Print time needed
     endTime = time.time()
-    log.info('Took %6.1f seconds to calculate.' % (endTime - startTime))
+    log.info("Took %6.1f seconds to calculate." % (endTime - startTime))
 
     return peakFilesDF
 
 
-if __name__ == '__main__':
-
-    parser = argparse.ArgumentParser(description='Run com1DFA workflow')
-    parser.add_argument('avadir', metavar='avalancheDir', type=str, nargs='?', default='',
-                        help='the avalanche directory')
-    parser.add_argument('-fc', '--friction_calibration', choices=['auto', 'large', 'medium', 'small', 'ini'],
-                        type=str, default='ini',
-                        help='friction calibration override, possible values are large, medium , small, auto and ini.' +
-                             'Overrides default AND local configs')
+if __name__ == "__main__":
+
+    parser = argparse.ArgumentParser(description="Run com1DFA workflow")
+    parser.add_argument(
+        "avadir", metavar="avalancheDir", type=str, nargs="?", default="", help="the avalanche directory"
+    )
+    parser.add_argument(
+        "-fc",
+        "--friction_calibration",
+        choices=["auto", "large", "medium", "small", "ini"],
+        type=str,
+        default="ini",
+        help="friction calibration override, possible values are large, medium , small, auto and ini."
+        + "Overrides default AND local configs",
+    )
 
     args = parser.parse_args()
     runCom1DFA(str(args.avadir), str(args.friction_calibration))