Install DebrisFrame

From PyPI

pip install debrisframe

This installs AvaFrame (avaframe>=2.2b1) as a dependency.

From source

Running DebrisFrame means running AvaFrame’s com1DFA with parameters for debris flows (c1TIF). Therefore, follow AvaFrame’s installation instructions first.

When you have setup AvaFrame you may copy the DebrisFrame repository in the same directory where you have installed AvaFrame in the previous step ([YOURDIR]). Afterwards, change into the DebrisFrame repository.

cd [YOURDIR]
git clone https://github.com/OpenNHM/DebrisFrame.git
cd DebrisFrame

Try a first run:

change into your debrisframe directory (replace [YOURDIR] with your path from the installation steps)

cd [YOURDIR]/DebrisFrame/debrisframe
pixi run python runC1TIF.py

From QGIS

DebrisFrame can be run from QGIS via the OpenNHMQGisConnector plugin. The plugin installs the required Python packages into QGIS’s Python environment and adds the DebrisFrame modules in the QGIS Processing Toolbox.

Install the connector from ZIP

The connector version required for DebrisFrame is not available on plugins.qgis.org yet and is distributed as a zip file instead.

  1. Get the OpenNHMQGisConnector.zip.

  2. In QGIS, open Plugins > Manage and Install Plugins... and switch to the Install from ZIP tab.

  3. Select the downloaded zip file and click Install Plugin.

  4. Make sure the plugin is enabled in the Installed tab.

Install the DebrisFrame package

  1. Open the Processing Toolbox (Processing > Toolbox).

  2. Expand OpenNHM > Admin and run Install DebrisFrame.

The tool installs the debrisframe package from PyPI. DebrisFrame requires AvaFrame >= 2.2b1. Since 2.2b1 is a pre-release, pip does not install it by default. The tool installs AvaFrame with the --pre flag. If an older AvaFrame is already installed, you are asked before it is replaced.

If you prefer to install AvaFrame 2.2b1 yourself, or if the installation via the tool fails, run:

python -m pip install --user --upgrade --pre avaframe

On Windows, open the OSGeo4W Shell from the start menu and run the command there. If you have multiple QGIS versions installed, choose the OSGeo4W Shell that matches your QGIS version.

Restart QGIS afterwards for the DebrisFrame tools to appear.

Run a module

After restarting QGIS, the DebrisFrame tools appear in the Processing Toolbox under DebrisFrame_Experimental. See Application via QGIS for an overview of the available modules and how to run them.