adapted to rebased master

avaframe/runStandardTestsCom4FlowPy.py

@@ -19,15 +19,15 @@
 from avaframe.in3Utils import logUtils
 
 
-def read_raster(path):
+def readRasters(path):
     raster = rasterio.open(path)
     output = raster.read(1)
     return output
 
 
-def compare(path, pathRef):
-    raster = read_raster(path)
-    rasterRef = read_raster(pathRef)
+def compareRasters(path, pathRef):
+    raster = readRasters(path)
+    rasterRef = readRasters(pathRef)
     diff = rasterRef - raster
     equal = np.array_equal(rasterRef, raster)
     closeArray = np.isclose(raster, rasterRef , rtol=1e-04, equal_nan=True)
@@ -36,7 +36,7 @@ def compare(path, pathRef):
 
 
 # Which result types for comparison plots
-outputVariable = ['FP_travel_angle', 'z_delta']
+outputVariable = ['fpTravelAngle', 'zdelta']
 
 # log file name; leave empty to use default runLog.log
 logName = 'runStandardTestsCom4FlowPy'
@@ -103,6 +103,9 @@ def compare(path, pathRef):
     cfgPath["tempDir"] = cfgPath["workDir"] / "temp"
     fU.makeADir(cfgPath["tempDir"])
     cfgPath["deleteTemp"] = "False"
+    cfgPath["uid"] = cfgUtils.cfgHash(cfg)
+    cfgPath["timeString"] = ""
+    cfgPath["outputFiles"] = "zDelta|travelLength|fpTravelAngle|flux"
 
     # Set timing
     startTime = time.time()
@@ -113,9 +116,9 @@ def compare(path, pathRef):
     log.info(('Took %s seconds to calculate.' % (timeNeeded)))
 
     for variable in outputVariable:
-        pathRasterRef = refDir / ('%s.tif' % variable)
-        pathRaster = compDir / ('%s.tif' % variable)
-        diff, eq, close = compare(pathRaster, pathRasterRef)
+        pathRasterRef = refDir / (f'com4_{cfgPath["uid"]}__{variable}.tif')
+        pathRaster = compDir / (f'com4_{cfgPath["uid"]}__{variable}.tif')
+        diff, eq, close = compareRasters(pathRaster, pathRasterRef)
 
         if eq and np.sum(abs(diff[diff != 0])) == 0:
             message = f'{testName}: for {variable}: rasters are equal \n'

benchmarksCom4FlowPy/avaArzlerAlm/ArzlerAlm_com4FlowPyCfg.ini

@@ -34,6 +34,29 @@ max_z = 8848
 
 infra = False
 
+#++++++++++++ Use a dynamic u_max Limit
+# Requires an additional tif-file containing the uMax  (in m/s)
+# or zDeltaMax (m) Limits
+# in every cell where a release cell is.
+# the paths for each release cells are calculated with these uMax values
+# (computed to z_delta, similar to the max_z) or zDelta values.
+# In varUmaxParameter the parameter (uMax in m/s or zDeltaMax in m) 
+# provided is given.
+variableUmaxLim = False
+varUmaxParameter = uMax
+
+#++++++++++++ Use a dynamic alpha angle
+# Requires an additional tif-file containing the alpha angles
+# in every cell where a release cell is.
+# The paths for each release cells are calculated with these alpha angles
+variableAlpha = False
+
+#++++++++++++ Use a dynamic exponent
+# Requires an additional tif-file containing the exponents
+# in every cell where a release cell is.
+# The paths for each release cells are calculated with these exponent
+variableExponent = False
+
 #++++++++++++ Use Forest Information
 # NOTE AH 20240408: Dummy settings for Forest Interaction
 # The forest implementation should mimick/reproduce the
@@ -42,7 +65,6 @@ infra = False
 #
 # Forest-Interaction is only used if 'forest' is set to 'True'
 #++++++++++++
-
 forest = False
 
 #++++++++++++
@@ -153,6 +175,23 @@ maxChunks = 500
 
 # Optional Custom Paths
 [PATHS]
+
+# define format of output raster files (default = .tif)
+# available options: [.tif, .asc]
+# if you plan to utilize avaFrame tools to analyse result rasters
+# then you should choose '.asc' here!
+outputFileFormat = .tif
+
+# define the different output files that are written to disk
+# default = 'zDelta|cellCounts|travelLength|fpTravelAngle'
+# additional options: 
+#                    slTravelAngle
+#                    flux
+#                    zDeltaSum
+# if forestInteraction: forestInteraction is automatically added to outputs
+# if infra: backCalculation is automatically  added to output
+outputFiles = zDelta|cellCounts|travelLength|fpTravelAngle|slTravelAngle|flux
+
 #++++++++++++ Custom paths True/False
 # default: False
 # if set to 'False':
@@ -176,6 +215,9 @@ demPath =
 releasePath =
 infraPath =
 forestPath =
+varUmaxPath = 
+varAlphaPath = 
+varExponentPath = 
 
 # plot save results flags------------------------
 # NOTE-TODO: These Flags still don't do anything,
@@ -197,4 +239,4 @@ writeRes = True
 # keep intermediate results
 fullOut = False
 
-#----------------------------------------------------------
+#----------------------------------------------------------

benchmarksCom4FlowPy/avaArzlerAlm/z_delta.tif.aux.xml

@@ -0,0 +1,11 @@
+<PAMDataset>
+  <PAMRasterBand band="1">
+    <Metadata>
+      <MDI key="STATISTICS_MAXIMUM">267.93823242188</MDI>
+      <MDI key="STATISTICS_MEAN">4.4432088366262</MDI>
+      <MDI key="STATISTICS_MINIMUM">0</MDI>
+      <MDI key="STATISTICS_STDDEV">26.540062227169</MDI>
+      <MDI key="STATISTICS_VALID_PERCENT">100</MDI>
+    </Metadata>
+  </PAMRasterBand>
+</PAMDataset>

benchmarksCom4FlowPy/avaParabolaChanneldPaper/parabChanneldPaperFP_com4FlowPyCfg.ini

@@ -34,6 +34,29 @@ max_z = 8848
 
 infra = False
 
+#++++++++++++ Use a dynamic u_max Limit
+# Requires an additional tif-file containing the uMax  (in m/s)
+# or zDeltaMax (m) Limits
+# in every cell where a release cell is.
+# the paths for each release cells are calculated with these uMax values
+# (computed to z_delta, similar to the max_z) or zDelta values.
+# In varUmaxParameter the parameter (uMax in m/s or zDeltaMax in m) 
+# provided is given.
+variableUmaxLim = False
+varUmaxParameter = uMax
+
+#++++++++++++ Use a dynamic alpha angle
+# Requires an additional tif-file containing the alpha angles
+# in every cell where a release cell is.
+# The paths for each release cells are calculated with these alpha angles
+variableAlpha = False
+
+#++++++++++++ Use a dynamic exponent
+# Requires an additional tif-file containing the exponents
+# in every cell where a release cell is.
+# The paths for each release cells are calculated with these exponent
+variableExponent = False
+
 #++++++++++++ Use Forest Information
 # NOTE AH 20240408: Dummy settings for Forest Interaction
 # The forest implementation should mimick/reproduce the
@@ -42,7 +65,6 @@ infra = False
 #
 # Forest-Interaction is only used if 'forest' is set to 'True'
 #++++++++++++
-
 forest = False
 
 #++++++++++++
@@ -153,6 +175,23 @@ maxChunks = 500
 
 # Optional Custom Paths
 [PATHS]
+
+# define format of output raster files (default = .tif)
+# available options: [.tif, .asc]
+# if you plan to utilize avaFrame tools to analyse result rasters
+# then you should choose '.asc' here!
+outputFileFormat = .tif
+
+# define the different output files that are written to disk
+# default = 'zDelta|cellCounts|travelLength|fpTravelAngle'
+# additional options: 
+#                    slTravelAngle
+#                    flux
+#                    zDeltaSum
+# if forestInteraction: forestInteraction is automatically added to outputs
+# if infra: backCalculation is automatically  added to output
+outputFiles = zDelta|cellCounts|travelLength|fpTravelAngle|slTravelAngle|flux
+
 #++++++++++++ Custom paths True/False
 # default: False
 # if set to 'False':
@@ -176,6 +215,9 @@ demPath =
 releasePath =
 infraPath =
 forestPath =
+varUmaxPath = 
+varAlphaPath = 
+varExponentPath = 
 
 # plot save results flags------------------------
 # NOTE-TODO: These Flags still don't do anything,
@@ -197,4 +239,4 @@ writeRes = True
 # keep intermediate results
 fullOut = False
 
-#----------------------------------------------------------
+#----------------------------------------------------------

benchmarksCom4FlowPy/avaParabolaChanneldPaper/z_delta.tif.aux.xml

@@ -0,0 +1,11 @@
+<PAMDataset>
+  <PAMRasterBand band="1">
+    <Metadata>
+      <MDI key="STATISTICS_MAXIMUM">218.48492431641</MDI>
+      <MDI key="STATISTICS_MEAN">5.4687844678271</MDI>
+      <MDI key="STATISTICS_MINIMUM">0</MDI>
+      <MDI key="STATISTICS_STDDEV">28.404478131686</MDI>
+      <MDI key="STATISTICS_VALID_PERCENT">100</MDI>
+    </Metadata>
+  </PAMRasterBand>
+</PAMDataset>