AvaFrame 2.0

AvaFrame 2.0 brings several user-facing changes. Most notably, simulation names now include the module name as part of their identifier (e.g. release1PF_4ab57f8760_com1_C_L_null_dfa instead of release1PF_4ab57f8760_C_L_null_dfa). Existing scripts or workflows that parse simulation names will need to be updated accordingly.

This release also introduces an advanced usage / expert configuration setup. Module default parameters can now be overridden via expert configuration files, either through the QGis Connector or by placing ini files in the project's Inputs/CFGs/ directory. For details, see the Advanced Usage documentation.

Com9MoTVoellmy recieved an update, with a new configuration version as well.

The AvaFrame QGis Connector has been superseded by the OpenNHM QGis Connector, which provides access to the main simulation and analysis workflows through the QGis processing framework. See the OpenNHM Connector documentation for available tools and setup instructions.

Breaking Changes since 1.13.2

Config / API changes

• getModuleConfig signature changed — positional override parameter replaced by explicit fileOverride keyword argument; avalancheDir parameter added; fileOverride and modInfo parameters subsequently removed entirely
• rewriteLocalCfgs and _removeCfgItemsNotInOverride removed from cfgUtils
• MoTGenerateConfigs removed — replaced by com1DFAPreprocess
• checkCfgInfoType removed from cfgUtils
• plotFields config key removed from com1DFA — resType now controls all output fields for all timesteps
• Com9MoTVoellmy changed its configuration version, which is incompatible with 1.13.2 ini files.

Renames

• THICKNESSThFromShp → THICKNESSThFromFile across all config files and code
• findAvaDirs (com7) moved to in3Utils as findAvaDirsBasedOnInputsDir
• splitInputsFlag → splitInputs in com7Regional

Output / result format changes

• Not-affected cells now use -9999 instead of 0 in all output rasters — new config parameter to define the no-data value
• Output rasters compressed by default when written as .tif
• Simulation name format changed — module name added as a component; multi-layer suffix (L1, L2, ...) added to filenames

Removed scripts / features

• runSplitInputs.py removed — functionality integrated into runCom7Regional.py via --split-inputs flag
• Windows-OS-specific conditional imports for multiprocessing removed

What's Changed

• [com1]: Assign values to returned variables in every condition by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1177
• [com7,in4] add regional modeling workflow for com1DFA by @leon-wagner in https://github.com/OpenNHM/AvaFrame/pull/1053
• [com1] add checking for zero mass of particle and remove properly by @awirb in https://github.com/OpenNHM/AvaFrame/pull/1180
• [com7] remove runSplitInputs.py and integrate functionality into runCom7Regional.py by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1181
• chore(config): remove .codeclimate.yml and add new log helper scripts by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1186
• [ana3;ana4;out3] allow 0 result raster in aimec by @awirb in https://github.com/OpenNHM/AvaFrame/pull/1189
• refactor(com7Regional): remove unused parameters from configuration file by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1191
• [com8] add renaming also for ent simType by @awirb in https://github.com/OpenNHM/AvaFrame/pull/1187
• [ana3] do not create plot if referene or comparison data only 0 values by @awirb in https://github.com/OpenNHM/AvaFrame/pull/1190
• chore(deps): add temporary dependencies gdal, libgdal, geos, proj in pyproject.toml by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1194
• [com1] Rheological Models for debris-flow simulations by @JuLa96 in https://github.com/OpenNHM/AvaFrame/pull/1169
• Renaming of FromShp to FromFiles in the ini files by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1197
• Renaming of FromShp to FromFiles in the ini files 2 by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1198
• docs(com9MoTVoellmy): update and expand documentation by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1196
• [com1;com8;com9;in1;in2;in3] Read from raster by @awirb in https://github.com/OpenNHM/AvaFrame/pull/1193
• feat(runCom6Scarp): add method override functionality for scarp analysis by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1209
• [com1;in2] Add tiff compression; adjust particles export logic by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1173
• [out3]: plot extent for values != 0 by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1210
• [StandardTestsCom1]: enable parallel execution by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1211
• [com1]: Add input hydrograph (initial) by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1167
• [com4]: all output rasters have value -9999 in not affected cells by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1164
• (com1) fix bug in with remeshed file writing due to compression by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1216
• [com1],[doc]: correct docu for raster inputs by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1214
• [doc]: fix thalweg computation equation by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1218
• [com4]: correct comment in ini file by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1220
• [com1], [out1], [doc]: Add timeInfo by @awirb in https://github.com/OpenNHM/AvaFrame/pull/1217
• [com1;in3] Change time writing [breaking change] by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1219
• Update path to github repository by @JuLa96 in https://github.com/OpenNHM/AvaFrame/pull/1223
• [ana3]: add writing of ref DF in aimec by @awirb in https://github.com/OpenNHM/AvaFrame/pull/1224
• [ana3;in3] add check for aimec new coordinate system by @awirb in https://github.com/OpenNHM/AvaFrame/pull/1225
• [com1;General] Add module name to simName by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1226
• refactor(config): Update pyproject.toml version pinning and add tasks by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1229
• [com1]: time dependent release option (hydrograph) for timestep 0 by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1215
• refactor(core): Adjust MacOS related imports and pixi setup by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1231
• [com1] Add cfg override folder / expert configuration by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1230
• [com1;com4;com8;com9] Removed Windows-OS-specific conditional imports for multiprocessing by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1234
• [doc] Update config documentation with graph by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1233
• [in3,com8,ana3] Add multi-layer result support; breaking change in com8 by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1236
• [com1]: Modify simhash with modifying time dependent release values by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1239
• [out3Plot] Add debris-flow topography by @JuLa96 in https://github.com/OpenNHM/AvaFrame/pull/1241
• [core, tests, docs] add remaining multi-layer support by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1242
• [com1]: write time depedent release infos into report by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1240
• [com6] Scarp: FinalUpdate by @dwolfsch in https://github.com/OpenNHM/AvaFrame/pull/1222
• feat(com9MoTVoellmy): add timeDependentRelease configuration by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1246
• [doc]: add documentation for time dep release by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1248
• chore(workflows): update GitHub Actions versions for dependencies by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1249
• [com1] Replace viscosity by consistency factor for Herschel-Bulkley rheology by @JuLa96 in https://github.com/OpenNHM/AvaFrame/pull/1252
• refactor(cfgUtils): handling of nan and special character checks in simDFTest by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1255
• Update energy line test cfg so that pfv fields are also saved by @awirb in https://github.com/OpenNHM/AvaFrame/pull/1256
• [doc]: restructure and merge usage documentation by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1257
• [com1] Add additional input options for rheological models by @JuLa96 in https://github.com/OpenNHM/AvaFrame/pull/1254
• [com5]: set detrainment to False by @awirb in https://github.com/OpenNHM/AvaFrame/pull/1259
• [runScripts]: wrap script execution in main block; fixes #1247 by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1258
• [Doc] Fix wrong equation references by @JuLa96 in https://github.com/OpenNHM/AvaFrame/pull/1260
• [doc]: standardize docs to pixi run commands by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1264
• [in3Utils] (geotrans) fill bilinear remesh edge NaNs with nearest fallback by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1266
• [data]: update scarpExample test inputs with new point and polygon configurations by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1265
• [out3Plot]: Add option for increased contrast in hillshades by @PaulaSp3 in https://github.com/OpenNHM/AvaFrame/pull/1262
• [com9;docs] update model configuration and executables (2026-04-20 Version) by @fso42 in https://github.com/OpenNHM/AvaFrame/pull/1268

New Contributors

• @JuLa96 made their first contribution in https://github.com/OpenNHM/AvaFrame/pull/1169

Full Changelog: https://github.com/OpenNHM/AvaFrame/compare/1.13.2...2.0