Skip to content

[com9;docs] update model configuration and executables (2026-04-20 Version) #1268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fso42 merged 2 commits into from
May 4, 2026
Merged

[com9;docs] update model configuration and executables (2026-04-20 Version) #1268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bfe5fa9
feat(com9MoTVoellmy): update model configuration and executables (202…
fso42 May 4, 2026
6697c99
docs(connector): update references from AvaFrameConnector to OpenNHMC…
fso42 May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified avaframe/com9MoTVoellmy/MoT-Voellmy_linux.exe
View file
Open in desktop
Binary file not shown.
Binary file modified avaframe/com9MoTVoellmy/MoT-Voellmy_win.exe
View file
Open in desktop
Binary file not shown.
10 changes: 5 additions & 5 deletions avaframe/com9MoTVoellmy/com9MoTVoellmyCfg.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ thFromIni =

# Below are the settings for the MoT-Voellmy model
[Run information]
MoT-Voellmy input file version = 2024-09-10
MoT-Voellmy input file version = 2026-04-20
Area of Interest = Testarea
UTM zone = 33N
EPSG geodetic datum code = 25833
Expand All @@ -159,10 +159,10 @@ Bed density (kg/m^3) = 140.0
Deposit density (kg/m^3) = 450.0
Rheology = Voellmy
Parameters = auto
Dry-friction coefficient (-) = 0.30
Turbulent drag coefficient (-) = 0.002
Dry-friction coefficient (-) = 0.40
Turbulent drag coefficient (-) = 0.001
Effective drag height (m) = 3.0
Centrifugal effects = yes
Centrifugal effects = no
Passive earth-pressure coeff. (-) = 1.0

[FOREST_EFFECTS]
Expand All @@ -189,5 +189,5 @@ Write maximum pressure = yes
Write instant. pressure = no
Minimum flow depth (m) = 0.01
Minimum speed (m/s) = 0.01
Momentum threshold (kg m/s) = 100.0
Minimum momentum fraction (%) = 1.0
Initial CFL number (-) = 0.8
20 changes: 0 additions & 20 deletions docs/advancedUsage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,6 @@
Advanced Usage (QGis, Script)
=============================

.. Warning::
The QGis Connector features described below require the **pre-release** versions of both AvaFrame and the
OpenNHM QGis Connector. They are not available in the current stable release.

To install:

1. Install the AvaFrame pre-release. On **Windows**, use the OSGeo4W Shell matching your QGis version.
On **Linux**, use the terminal in the environment you are using. Then run::

pip install avaframe==2.0rc3

2. Download the OpenNHM QGis Connector zip from the
`GitHub Releases <https://github.com/OpenNHM/AvaFrame/releases>`_ page.

3. In QGis, go to **Plugins > Manage and Install Plugins**, choose **Install from ZIP** and select the
downloaded file.

Check `PyPI <https://pypi.org/project/avaframe/#history>`_ for the latest AvaFrame pre-release version and
`GitHub Releases <https://github.com/OpenNHM/AvaFrame/releases>`_ for the newest connector zip.

.. Warning::
Modifying default parameters moves you outside the validated and calibrated setup.
Results are no longer covered by the standard validation and you use them at your own risk.
Expand Down
3 changes: 2 additions & 1 deletion docs/developinstallwin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,5 @@ To run QGIS (this will install the environment on first use)::
Depending on your mode of QGis installation (direct installer, conda, OSGeo4W...) your script AvaFrame installation
might be overruled...

Now you can **install the AvaFrameConnector plugin** via QGIS as per usual (:ref:`standardUsage:Standard Usage (QGis)`).
Now you can **install the OpenNHMConnector plugin** via QGIS as per usual (:ref:`standardUsage:Standard Usage
(QGis)`).
11 changes: 3 additions & 8 deletions docs/moduleCom9MoTVoellmy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,10 @@ MoT Voellmy via QGis
Installation on Windows:
^^^^^^^^^^^^^^^^^^^^^^^^

#. Open the OSGeo4WShell that matches your QGis installation
#. Run::

pip install avaframe==2.0a3

#. Start QGis and go to `Plugins` -> `Manage and install plugins`
#. Choose `All`, search for `AvaFrame` and install/update
#. You find the `AvaFrame` toolset in the `Processing Toolbox`
#. Go to `NGI_experimental` and start `MoTVoellmy (com9)`
#. Choose `All`, search for `OpenNHM` and install/update
#. You find the `OpenNHM` toolset in the `Processing Toolbox`
#. Go to `AvaFrame_experimental` and start `MoTVoellmy (com9)`


Input
Expand Down
6 changes: 3 additions & 3 deletions docs/operational.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ Setup QGis and run

#. Open QGis from your start menu and go to Plugins -> Manage and Install Plugins

#. Search for `AvaFrameConnector` and install it
#. Search for `OpenNHMConnector` and install it

#. Access the QGis - Avaframe connector via Toolbox -> AvaFrame -> AvaFrameConnector
#. Access the QGis - OpenNHM connector via Toolbox -> OpenNHM -> OpenNHMConnector

#. Add the described data and run. Results will be loaded after a while
(depending on the size of your DEM).
Expand Down Expand Up @@ -87,7 +87,7 @@ Update Avaframe to a new release

#. Restart/Open QGis from your start menu and go to Plugins -> Manage and Install Plugins

#. Search for `AvaFrameConnector` and check whether it also needs updating
#. Search for `OpenNHMConnector` and check whether it also needs updating


.. Note::
Expand Down
6 changes: 3 additions & 3 deletions docs/operationalGerman.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ Setup QGis

#. Öffnen Sie QGis über Ihr Startmenü und gehen Sie zu Erweiterungen -> Erweiterungen verwalten und installieren

#. Nach `AvaFrameConnector` suchen und installieren
#. Nach `OpenNHMConnector` suchen und installieren

#. Rufen Sie den QGis - AvaframeConnector über Verarbeitungswerkzeuge -> AvaFrame -> AvaFrameConnector auf
#. Rufen Sie den QGis - OpenNHMConnector über Verarbeitungswerkzeuge -> OpenNHM -> OpenNHMConnector auf

#. Fügen Sie die beschriebenen Daten hinzu und starten Sie den Connector. Die Ergebnisse werden nach einer Weile geladen
(abhängig von der Größe Ihres DEM).
Expand Down Expand Up @@ -86,7 +86,7 @@ Update Avaframe

#. Starten Sie QGis neu/öffnen Sie es über Ihr Startmenü und gehen Sie zu Plugins -> Plugins verwalten und installieren

#. Suchen Sie nach AvaFrameConnector und prüfen Sie, ob es aktualisiert werden muss
#. Suchen Sie nach OpenNHMConnector und prüfen Sie, ob es aktualisiert werden muss


.. Note::
Expand Down
24 changes: 12 additions & 12 deletions docs/standardUsage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@ The prerequisites are:
* QGis: install from here: `QGis installation <https://qgis.org/en/site/forusers/download.html>`_ (we recommend
using the latest version)

Setup AvaFrameConnector and run
Setup OpenNHMConnector and run
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#. Open QGis from your start menu and go to Plugins -> Manage and Install Plugins

#. Search for `AvaFrameConnector` and install it
#. Search for `OpenNHMConnector` and install it

#. Wait for it to finish and restart QGis

#. Access the QGis - Avaframe connector via Toolbox -> AvaFrame -> Operational -> FullOperationalRun
#. Access the QGis - OpenNHM connector via Toolbox -> OpenNHM -> AvaFrame_Operational -> FullOperationalRun

#. Add the described data and run. Results will be loaded after a while
(depending on the size of your DEM)

This tries to install the AvaFrame core package as well (since AvaFrameConnector version 1.2). If it fails, head
This tries to install the AvaFrame core package as well (since OpenNHMConnector version 1.2). If it fails, head
over to the :ref:`operational:Manual Installation` instructions.

For more information about the functions in the connector, see :ref:`connector:OpenNHM QGis Connector`
Expand All @@ -37,9 +37,9 @@ Update Avaframe to a new version

#. Restart/Open QGis from your start menu and go to Plugins -> Manage and Install Plugins

#. Search for `AvaFrameConnector` and check whether it also needs updating
#. Search for `OpenNHMConnector` and check whether it also needs updating

#. Access the QGis - Avaframe connector via Toolbox -> AvaFrame
#. Access the QGis - OpenNHM connector via Toolbox -> OpenNHM

#. Go to the *Admin* section, choose and run *Update*. This updates the AvaFrame core package.

Expand All @@ -60,21 +60,21 @@ Die Vorraussetzungen sind:
* QGis: `QGis Installation (download) <https://qgis.org/de/site/forusers/download.html>`_ (Wir empfehlen die aktuellste Version zu
verwenden)

Setup AvaFrameConnector
Setup OpenNHMConnector
"""""""""""""""""""""""

#. Öffnen Sie QGis über Ihr Startmenü und gehen Sie zu Erweiterungen -> Erweiterungen verwalten und installieren

#. Nach `AvaFrameConnector` suchen und installieren
#. Nach `OpenNHMConnector` suchen und installieren

#. Warten Sie, bis der Vorgang abgeschlossen ist und starten Sie QGis neu

#. Rufen Sie den QGis - AvaframeConnector über Verarbeitungswerkzeuge -> AvaFrame -> Operational -> FullOperationalRun auf
#. Rufen Sie den QGis - OpenNHMConnector über Verarbeitungswerkzeuge -> OpenNHM -> AvaFrame_Operational -> FullOperationalRun auf

#. Fügen Sie die beschriebenen Daten hinzu und starten Sie den Connector. Die Ergebnisse werden nach einer Weile geladen
(abhängig von der Größe Ihres DEM)

Hiermit wird versucht das AvaFrame-Kernpaket zu installieren (seit AvaFrameConnector Version 1.2). Wenn dies fehlschlägt, gehen Sie
Hiermit wird versucht das AvaFrame-Kernpaket zu installieren (seit OpenNHMConnector Version 1.2). Wenn dies fehlschlägt, gehen Sie
zu: :ref:`operationalGerman:Manuelle Installation`.

Für eine Kurzzusammenfassung der Funktionen des Connectors, siehe :ref:`connector:OpenNHM QGis Connector`.
Expand All @@ -84,9 +84,9 @@ Update Avaframe auf eine neue Version

#. Starten Sie QGis neu/öffnen Sie es über Ihr Startmenü und gehen Sie zu Plugins -> Plugins verwalten und installieren

#. Suchen Sie nach AvaFrameConnector und prüfen Sie, ob es aktualisiert werden muss
#. Suchen Sie nach OpenNHMConnector und prüfen Sie, ob es aktualisiert werden muss

#. Rufen Sie den QGis - AvaframeConnector über Verarbeitungswerkzeuge -> AvaFrame auf
#. Rufen Sie den QGis - OpenNHMConnector über Verarbeitungswerkzeuge -> OpenNHM auf

#. Dann -> Admin -> Update aufrufen

Loading