[ana6, com8]: Add ana6Optimisation Module, apply changes in com8MoTPSA by RolandFischbacher · Pull Request #1245 · OpenNHM/AvaFrame

RolandFischbacher · 2026-02-23T17:47:10Z

This PR introduces a new optimisation module ana6Optimisation for com8MoTPSA and updates the simulation workflow.

The module ana6Optimisation includes:

Calculation of combined loss function (runout + tversky)
Morris sensitivity analysis for parameter ranking
Sequential and non-sequential surrogate based optimisation routines

New files in ana6Opitmisaton:

runMorrisSA.py (configuration: runMorrisSACfg.ini)
runPlotMorrisConvergence.py (uses runMorrisSACfg.ini)
runOptimisation.py (configuration: runOptimisationCfg.ini)
optimisationUtils.py
README_ana6.md (contains usage instructions)

New file in out3Plot:

outAna6Plots.py

Changed workflow of runing com8MoTPSA:

Check prior if simulation is run already
Process in chunks not all simulations at once

qltysh · 2026-02-23T17:48:47Z

❌ 3 blocking issues (3 total)

Tool	Category	Rule	Count
black	Style	Incorrect formatting, autoformat by running `qlty fmt`.	3	❌

@qltysh one-click actions:

Auto-fix formatting (qlty fmt && git push)

avaframe/ana3AIMEC/aimecTools.py

avaframe/ana6Optimisation/README_ana6.md

avaframe/ana6Optimisation/optimisationUtils.py

avaframe/out3Plot/outAna6Plots.py

avaframe/ana6Optimisation/optimisationUtils.py

avaframe/out3Plot/outAna6Plots.py

avaframe/ana3AIMEC/aimecTools.py

avaframe/ana3AIMEC/ana3AIMEC.py

avaframe/out3Plot/outQuickPlot.py

avaframe/ana6Optimisation/optimisationUtils.py

avaframe/ana3AIMEC/aimecTools.py

avaframe/ana6Optimisation/README_ana6.md

avaframe/ana6Optimisation/optimisationUtils.py

avaframe/com8MoTPSA/com8MoTPSA.py

avaframe/out1Peak/outPlotAllPeakDiffs.py

avaframe/out3Plot/outAIMEC.py

Squash of 20 commits from RF_com8MoTPSA branch including: - com8MoTPSA workflow improvements (chunked multiprocessing, path handling) - Bayesian optimisation integration (ana6Optimisation module) - Morris sensitivity analysis scripts - AIMEC runout reference implementation - probAna pickle saving and bounds - Plotting and config improvements

avaframe/ana6Optimisation/optimisationUtils.py

avaframe/com8MoTPSA/com8MoTPSA.py

qltysh · 2026-02-24T14:41:27Z

Coverage Impact

⬇️ Merging this pull request will decrease total coverage on master by 0.19%.

Modified Components (1)

Rating	Component	% Diff
	com1DFA	—

Modified Files with Diff Coverage (2)

File	% Diff	Uncovered Line #s
avaframe/com8MoTPSA/com8MoTPSA.py	0.0%	21-182
avaframe/in3Utils/cfgUtils.py	71.4%	995, 1016
Total	10.0%

🤖 Increase coverage with AI coding...

In the `RF_com8MoTPSA` branch, add test coverage for this new code:

- `avaframe/com8MoTPSA/com8MoTPSA.py` -- Line 21-182
- `avaframe/in3Utils/cfgUtils.py` -- Lines 995 and 1016

🚦 See full report on Qlty Cloud »

🛟 Help

Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.
Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.
File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)
- Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

avaframe/runScripts/runPlotAreaRefDiffs.py

…s and checks

avaframe/out3Plot/outAna6Plots.py

- Add bounds to paramValuesD in createSamplesWithVariation (StandardParameters) - Add writing of visualisation scenario and sampling method to com8MoTPSACfg.ini

avaframe/out3Plot/outAna6Plots.py

…bles

avaframe/out3Plot/outAna6Plots.py

avaframe/ana6Optimisation/optimisationUtils.py

avaframe/ana4Stats/probAna.py

avaframe/ana6Optimisation/runOptimisation.py

avaframe/ana6Optimisation/optimisationUtils.py

…i file, delete redundant code

…ameCfg.ini nCPU

…Files in optimisationUtils.py), add possibility to RUN writeCfgFiles with counter

…clean header Implement modName to make code general and remove adjustText package

…ror and stale values and remove copy paste error.

… added to cfgStart. And read sample method with fallback; meaning if 'PROBANA' or 'sampleMethod' is missing sample_method contains an empty string

avaframe/ana4Stats/probAna.py

avaframe/ana6Optimisation/optimisationUtils.py

avaframe/com8MoTPSA/com8MoTPSA.py

… docstring, tidy up code, add if __name__='__main__': in runPlotMorrisConvergence.py and improve BOConvergencePlot.

avaframe/out3Plot/outAna6Plots.py

…names from paper to com8MoTPSACfg.ini.

awirb

first comments, more to come

awirb · 2026-03-09T07:18:59Z

avaframe/in3Utils/cfgUtils.py

    # check for allConfigurationsInfo to find computation info and add to info fetched from ini files
    if latest == False and isinstance(simDF, pd.DataFrame):
        # check if in allConfigurationsInfo also info for existing sims
        simDFALL, _ = readAllConfigurationInfo(avaDir, specDir="", configCsvName="allConfigurations")


would you also require here to set the modName variable that it doesn't just read the allConfigurations.csv from the Outputs of com1DFA?

allConfigurations.csv is currently not available for com8MoTPSA module

awirb · 2026-03-09T07:44:28Z

avaframe/ana6Optimisation/runOptimisationCfg.ini

@@ -0,0 +1,64 @@
+### Config File - This file contains the main settings for the optimisation process 
+
+# Sidenote: (1) when running runOptimisation.py the working directory needs to be in the ana6Optimisation folder


why is it actually located here and not in the runScripts directory?

awirb · 2026-03-09T07:45:08Z

avaframe/ana6Optimisation/runOptimisationCfg.ini

+
+
+[GENERAL]
+# USER input for running and plotting a comparison of simulation result to reference polygon


does this refer to the settings in runPlotAreaProfile?

Yes this refers to the settings in runPlotAreaRefDiffs.py

avaframe/ana6Optimisation/runOptimisationCfg.ini

avaframe/ana6Optimisation/README_ana6.md

awirb · 2026-03-09T08:02:21Z

avaframe/ana6Optimisation/README_ana6.md

+- **Digital Elevation Model (DEM)**  
+  Must be placed directly in the `Inputs` directory and must cover the entire affected area.
+
+More Details here: https://docs.avaframe.org/en/latest/moduleCom1DFA.html


Do you mean that in provided link in section Inputs?

avaframe/ana6Optimisation/README_ana6.md

avaframe/ana6Optimisation/runMorrisSACfg.ini

avaframe/ana6Optimisation/runOptimisationCfg.ini

# Conflicts: # avaframe/ana6Optimisation/README_ana6.md

awirb

comments for the optimisation part and plotting still missing

avaframe/ana6Optimisation/optimisationUtils.py

awirb · 2026-03-09T14:53:15Z

avaframe/ana6Optimisation/optimisationUtils.py

+    cfgAIMEC = cfgUtils.getModuleConfig(ana3AIMEC)
+    rasterTransfo, resAnalysisDF, plotDict, _, pathDict = ana3AIMEC.fullAimecAnalysis(avalancheDir, cfgAIMEC)


instead of using the passed module, consider loading the config already in the runScript before you call the function and just pass the config, then also the override is easier (using ana3AIMEC_ana3AIMEC_override) or is there a special reason for passing the module?

passing the module in to the calcArealIndicatorsAndAIMEC function is not necessary, since the AIMEC settings are not overridden, i think that not passing the module and loading config here should be sufficient?

avaframe/ana6Optimisation/optimisationUtils.py

avaframe/ana6Optimisation/runMorrisSA.py

awirb · 2026-03-10T07:02:09Z

avaframe/ana6Optimisation/runMorrisSA.py

+        )
+        raise ValueError(message)
+
+    paramLossSubsetDF = paramLossDF.sort_values(by='Loss', ascending=True)[:N]


why is the [:N] needed - is that from start to the end if len(DF) is N no?

It defines how much of the best ranked morris samples to use for statistics. (e.g. parameter distribution within this topN samples). I changed the name to topN.

awirb · 2026-03-10T07:04:41Z

avaframe/ana6Optimisation/optimisationUtils.py

+
+def createDFParameterLoss(df, paramSelected):
+    """
+    Create DataFrames linking selected parameters with the loss function.


does selected mean - the ones that were used for the parameter variation using the morris sampling method?

selected depends on scenario: if morris is not run prior, then selected means all parameters that were varied, and if morris is run prior, selected means take only topN most important parameters

avaframe/ana6Optimisation/optimisationUtils.py

avaframe/ana6Optimisation/runMorrisSACfg.ini

… 2 (1 more important),

…consistent with runOptimisationCfg.ini) and add comments.

avaframe/ana6Optimisation/runOptimisation.py

avaframe/ana6Optimisation/optimisationUtils.py

awirb · 2026-03-11T11:35:06Z

avaframe/ana6Optimisation/optimisationUtils.py

+        - The top-N most influential parameters are selected for optimisation.
+
+    Scenario 2 (Manual definition):
+        - No prior Morris screening.


If I understood correctly, Morris analysis could have been performed previously to decide which parameters should be considered in the optimisation and which ones do not have a strong effect on the loss function and are therefore not considered? So scenario 2 just means that first simulations have to be performed to start the optimisation with or used from the ana4Prob run?

so in contrast in scenario 1 the simulations performed for the morris analysis using the morris sampling are used directly?

Yes, the statement is correct.

awirb · 2026-03-11T11:42:01Z

avaframe/ana6Optimisation/optimisationUtils.py

+def loadVariationData(cfgOpt, outDir, avaDir):
+    """
+    Load parameter bounds and selected parameters for optimisation. Two execution modes are supported, controlled via
+    cfgOpt['PARAM_BOUNDS']['scenario']:


in the description of the scenarios below, both say that the parameter bounds are either read from sa_parameter_bounds.pkl (scenario 1) or from paramValuesD.pickle created in the runAna4ProbAna (scenario 2) - so cfgOpt['PARAM_BOUNDS'] is not used? consider mentioning already here that this relies on previous simulation runs performed using Morris analysis or ana4ProbAna

cfgOpt['PARAM_BOUNDS'] is used to determine which file is read, either sa_parameter_bounds.pkl or paramValuesD.pickle

avaframe/ana6Optimisation/optimisationUtils.py

avaframe/ana6Optimisation/runOptimisationCfg.ini

awirb · 2026-03-11T11:54:12Z

avaframe/ana6Optimisation/runOptimisation.py

+    paramBounds, paramSelected = optimisationUtils.loadVariationData(cfgOpt, inDir, avalancheDir)
+
+    # Calculate Areal indicators and AIMEC and save the results in Outputs/ana3AIMEC and Outputs/out1Peak
+    optimisationUtils.calcArealIndicatorsAndAimec(cfgOpt, avalancheDir, ana3AIMEC)


so for the areal indicators, the settings are read from cfgOpt for aimec from the aimecCfg - here we could use the override config functionality

avaframe/ana6Optimisation/runOptimisation.py

avaframe/out3Plot/outAna6Plots.py

…IMECcfg.ini settings and not pass AIMEC module for calcArealIndicatorsAndAIMEC

…ed as default

…nvergence.py

avaframe/out3Plot/outAna6Plots.py

RolandFischbacher requested review from awirb and fso42 February 23, 2026 17:47

RolandFischbacher self-assigned this Feb 23, 2026

RolandFischbacher added the enhancement New feature or request label Feb 23, 2026

qltysh bot reviewed Feb 23, 2026

View reviewed changes

fso42 added this to the Version 2.0 milestone Feb 23, 2026

fso42 changed the title ~~[ana6Opitmisation], [com8MoTPSA]: Add ana6Optimisation Module, apply changes in com8MoTPSA~~ [ana6, com8]: Add ana6Optimisation Module, apply changes in com8MoTPSA Feb 24, 2026

RolandFischbacher force-pushed the RF_com8MoTPSA branch from f66f702 to 38e42ca Compare February 24, 2026 08:50

qltysh bot reviewed Feb 24, 2026

View reviewed changes

fso42 assigned fso42 and unassigned RolandFischbacher Feb 24, 2026

fso42 force-pushed the RF_com8MoTPSA branch from 38e42ca to 15f5438 Compare February 24, 2026 14:35

qltysh bot reviewed Feb 24, 2026

View reviewed changes

avaframe/ana6Optimisation/optimisationUtils.py Show resolved Hide resolved

avaframe/ana6Optimisation/optimisationUtils.py Outdated Show resolved Hide resolved

avaframe/com8MoTPSA/com8MoTPSA.py Outdated Show resolved Hide resolved

avaframe/com8MoTPSA/com8MoTPSA.py Show resolved Hide resolved

fso42 assigned RolandFischbacher and unassigned fso42 Feb 24, 2026

RolandFischbacher commented Feb 24, 2026

View reviewed changes

avaframe/runScripts/runPlotAreaRefDiffs.py Outdated Show resolved Hide resolved

refactor(runScripts): runPlotAreaRefDiffs,removing unused condition…

e41ff1c

…s and checks

qltysh bot reviewed Feb 26, 2026

View reviewed changes

avaframe/out3Plot/outAna6Plots.py Outdated Show resolved Hide resolved

RolandFischbacher added 2 commits February 26, 2026 09:43

fix(probAna): restore missing bounds and config writing after merge

a7f0a5e

- Add bounds to paramValuesD in createSamplesWithVariation (StandardParameters) - Add writing of visualisation scenario and sampling method to com8MoTPSACfg.ini

Merge remote-tracking branch 'origin/RF_com8MoTPSA' into RF_com8MoTPSA

3f4d1e5

qltysh bot reviewed Feb 26, 2026

View reviewed changes

avaframe/out3Plot/outAna6Plots.py Show resolved Hide resolved

fix: handle new _L1/_L2 naming in merging logic and rename some varia…

97fd380

…bles

qltysh bot reviewed Feb 26, 2026

View reviewed changes

avaframe/out3Plot/outAna6Plots.py Show resolved Hide resolved

avaframe/out3Plot/outAna6Plots.py Show resolved Hide resolved

fso42 requested changes Feb 26, 2026

View reviewed changes

OpenNHM deleted a comment from qltysh bot Feb 27, 2026

RolandFischbacher added 8 commits February 28, 2026 13:44

change function name, move parameter to ini file, change values of in…

7c32be0

…i file, delete redundant code

Add: if __name__ == '__main__'

81b2d68

Fix: remove duplicate in com8MoTPSAMain and read chunkSize from avafr…

76b0dc8

…ameCfg.ini nCPU

Implement a direct call of com8MoTPSAMain with updated cfgs (writeCfg…

3d831a7

…Files in optimisationUtils.py), add possibility to RUN writeCfgFiles with counter

Use logging instead of print in optimisationUtils.py

8843c22

Add sklearn (scikit-learn) to the requirements in pyproject.toml and …

51ac8a1

…clean header Implement modName to make code general and remove adjustText package

Initialize index and sampleMethod with np.nan to avoid UnboundLocalEr…

0f4e968

…ror and stale values and remove copy paste error.

Add a check if 'VISUALISATION' exists in cfgStart, if not, it will be…

4d36ca4

… added to cfgStart. And read sample method with fallback; meaning if 'PROBANA' or 'sampleMethod' is missing sample_method contains an empty string

qltysh bot reviewed Feb 28, 2026

View reviewed changes

avaframe/ana4Stats/probAna.py Show resolved Hide resolved

avaframe/ana6Optimisation/optimisationUtils.py Outdated Show resolved Hide resolved

avaframe/ana6Optimisation/optimisationUtils.py Show resolved Hide resolved

avaframe/com8MoTPSA/com8MoTPSA.py Show resolved Hide resolved

Make optimisationType case-insensitive, add raise ValueErrors, update…

0e7b446

… docstring, tidy up code, add if __name__='__main__': in runPlotMorrisConvergence.py and improve BOConvergencePlot.

qltysh bot reviewed Mar 2, 2026

View reviewed changes

avaframe/out3Plot/outAna6Plots.py Show resolved Hide resolved

RolandFischbacher added 2 commits March 9, 2026 12:27

Add description of Loss function to README_ana6.md.

67a5886

Add description of Loss function to README_ana6.md and add parameter …

da3f6db

…names from paper to com8MoTPSACfg.ini.

awirb reviewed Mar 9, 2026

View reviewed changes

Merge remote-tracking branch 'origin/RF_com8MoTPSA' into RF_com8MoTPSA

20b8cd0

# Conflicts: # avaframe/ana6Optimisation/README_ana6.md

awirb reviewed Mar 10, 2026

View reviewed changes

RolandFischbacher added 3 commits March 12, 2026 17:57

Add more info and layer handling in Cfg.ini files,swap scenario 1 and…

9c1940a

… 2 (1 more important),

Revise README_ana6.md

e0c0307

Use cfg.getint(...) instead of int(cfg(...)), swap scenario 1 and 2 (…

9c6432c

…consistent with runOptimisationCfg.ini) and add comments.

awirb reviewed Mar 13, 2026

View reviewed changes

RolandFischbacher added 4 commits March 14, 2026 13:19

Improve documentation, construct the filename of AIMEC results from A…

39b8dbe

…IMECcfg.ini settings and not pass AIMEC module for calcArealIndicatorsAndAIMEC

Add definition of chunkSize to probAnaCfg.ini, if left empty 10 is us…

4085755

…ed as default

Fix typo in com8MoTPSACfg.ini and Fix cfg handling in runPlotMorrisCo…

a28eb40

…nvergence.py

Add y scaled boxplot and boxplot of simulations with no PSC

c317e0e

qltysh bot reviewed Mar 23, 2026

View reviewed changes

avaframe/out3Plot/outAna6Plots.py Show resolved Hide resolved

avaframe/out3Plot/outAna6Plots.py Show resolved Hide resolved

		@@ -0,0 +1,64 @@
		### Config File - This file contains the main settings for the optimisation process

		# Sidenote: (1) when running runOptimisation.py the working directory needs to be in the ana6Optimisation folder



		[GENERAL]
		# USER input for running and plotting a comparison of simulation result to reference polygon

		cfgAIMEC = cfgUtils.getModuleConfig(ana3AIMEC)
		rasterTransfo, resAnalysisDF, plotDict, _, pathDict = ana3AIMEC.fullAimecAnalysis(avalancheDir, cfgAIMEC)

Conversation

RolandFischbacher commented Feb 23, 2026

The module ana6Optimisation includes:

Changed workflow of runing com8MoTPSA:

Uh oh!

qltysh bot commented Feb 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qltysh bot commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

awirb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

qltysh bot commented Feb 23, 2026 •

edited

Loading

qltysh bot commented Feb 24, 2026 •

edited

Loading

RolandFischbacher Mar 10, 2026 •

edited

Loading

RolandFischbacher Mar 12, 2026 •

edited

Loading