[c2]: Add module c2TopRunDF by PaulaSp3 · Pull Request #52 · OpenNHM/DebrisFrame

PaulaSp3 · 2026-01-28T17:02:42Z

runC2TopRunDF.pyexecutes pyTopRunDF for one scenario.

The file TopRunDF.py is modified, batch_select_process.py is not used here (since a run of multiple scenarios is not enabled yet), the other files are directly used from the pyTopRunDF repository. The pyTopRunDF repository is integrated via a submodule into c2TopRunDF/pyTopRunDF, from where the original scripts are executed.

The modification of TopRunDF.py enables more consistency with the AvaFrame/DebrisFrame configuration and input handling:

a different handling with input parameters: we use an c2TopRunDFCfg.ini file instead of a .json file (including a different location!)
Input data (the DEM) is located in avalanchedir/Inputs, the avalanchedir is defined in debrisframe.ini (or local_debrisframe.ini) instead of Scenarios/Scenario_{num}
Output data are saved in avalanchedir/Outputs instead of Outputs/Scenario_{num}

Adding a global seed to the random functions yields the same result as that computed with the original code (with the same seed) for Scenario_1 (in pyTopRunDF repository.

Documentation ends up here:
https://docs.debrisframe.org/en/ps_toprundf/installation.html

add computation tidy up the code tidy up correct logger

This reverts commit a99540e.

This reverts commit 27bf58b.

update submodule update ref data

qltysh · 2026-01-28T17:03:49Z

❌ 1 blocking issue (3 total)

Tool	Category	Rule	Count
ruff	Lint	`pytest` imported but unused	1	❌
qlty	Structure	Function with high complexity (count = 40): c2TopRunDFMain	1
qlty	Structure	Deeply nested control flow (level = 4)	1

debrisframe/c2TopRunDF/c2TopRunDF.py

qltysh · 2026-01-28T17:03:51Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+                            area += 1
+                else:
+                    mcs += 1
+                    position = [row, col]


Deeply nested control flow (level = 4) [qlty:nested-control-flow]

qltysh · 2026-01-28T17:03:51Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+
+    plotter = HillshadePlotter()
+
+    # Generate the plot


Function with high complexity (count = 40): c2TopRunDFMain [qlty:function-complexity]

debrisframe/c2TopRunDF/testOutput.py

qltysh · 2026-01-28T17:05:44Z

Coverage Impact

This PR will not change total coverage.

Modified Files with Diff Coverage (1)

Rating	File	% Diff	Uncovered Line #s
	debrisframe/tests/test_c2TopRunDF.py	100.0%
	Total	100.0%

🚦 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.

debrisframe/c2TopRunDF/c2TopRunDF.py

debrisframe/c2TopRunDF/testClass.py

debrisframe/c2TopRunDF/testRasterio.py

qltysh · 2026-01-29T09:55:29Z

debrisframe/tests/test_c2TopRunDF.py

+import configparser
+import pathlib
+import shutil
+import pytest


pytest imported but unused [ruff:F401]

fso42

Please add an init.py in c2

fso42 · 2026-02-09T09:01:04Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+
+    artificial_height = cfgDebris["GENERAL"]["energyHeight"]
+    if artificial_height == "elevation":
+        artificial_raster_height = rasterio.open(output_dir / "elevation.asc")


This is never closed. Either use with or explicitly close it

fso42 · 2026-02-09T09:01:13Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+    # Open the DEM file
+    # Preprocess the DEM file if necessary
+    processed_dem_file = preprocess_raster(dem_file)
+    dataset = rasterio.open(processed_dem_file)


fso42 · 2026-02-09T09:03:14Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+    # Clean up the temporary file if preprocessing was done
+    if processed_dem_file != dem_file:
+        processed_dem_file.unlink()  # Deletes the temporary file
+    fin = "finished"


This and the if seen to be dead code? fin is alway finished?

fso42 · 2026-02-09T09:04:04Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+    max_val = np.amax(band3)
+    band3 = band3 / max_val
+    meanh = volume / perimeter
+    band4 = band3 * meanh


This is overwritten 5 lines down without ever being used. Is this intentional?

fso42 · 2026-02-09T09:04:49Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+                    position = [row, col]
+                    band2.fill(0)
+
+    band3[0, 0] = 0


Why is this needed?

fso42 · 2026-02-09T09:09:37Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+    mcsmax = 500
+
+    # Flowpath simulation
+    for x in range(0, 100000):


Should this value go to ini?

fso42 · 2026-02-09T09:10:04Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+    band3 = np.copy(band)
+    band3.fill(0)
+    area = 0
+    mcsmax = 500


Value for ini?

fso42 · 2026-02-09T09:10:41Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+                        # significant over longer distances. A smaller denominator causes faster decay, meaning
+                        # the decay factor approaches zero more quickly.
+                        distance = np.sqrt((position[0] - row) ** 2 + (position[1] - col) ** 2)
+                        decay_factor = np.exp(-distance / 100)  # Example decay factor with denominantor=100


Same here, controlable via ini?

fso42 · 2026-02-09T09:11:13Z

debrisframe/c2TopRunDF/c2TopRunDF.py

+    # and distribute them more evenly. It simulates the physical process of diffusion,
+    # in which material or energy moves from areas of high concentration to areas of low
+    # concentration.
+    kernel = np.array([[0.05, 0.1, 0.05],


Values for ini?

fso42 · 2026-02-09T09:12:19Z

docs/source/installation.rst

+and edit ``local_debrisframeCfg.ini`` with your favorite text editor and adjust the variable
+``avalancheDir`` for example to ``data/debrisTopRun``, then run::
+
+  python runC2ToprunDF.py


Typo: TopRun instead of Toprun

PaulaSp3 and others added 8 commits January 27, 2026 15:59

add original structure of TopRunDF, (to run only one scenario)

57feff4

add computation tidy up the code tidy up correct logger

use raster funtions from AvaFrame, still very slow

27bf58b

enable a faster simulation

a99540e

add reference output from original pyTopRunDF and somple comparison test

3bc62c6

Revert "enable a faster simulation"

5c26c97

This reverts commit a99540e.

Revert "use raster funtions from AvaFrame, still very slow"

2c204cf

This reverts commit 27bf58b.

try to use topRunDF modules from original repo

8bb523b

add c2TopRunDF to doc

6fa25dd

update submodule update ref data

PaulaSp3 self-assigned this Jan 28, 2026

PaulaSp3 linked an issue Jan 28, 2026 that may be closed by this pull request

[c2]: modify pyTopRunDF in DebrisFrame? #49

Open

7 tasks

PaulaSp3 added the enhancement New feature or request label Jan 28, 2026

qltysh bot reviewed Jan 28, 2026

View reviewed changes

PaulaSp3 added 3 commits January 28, 2026 18:13

update doc

1418a52

random seed for reproducability

ceaff14

add author

0b9c11a

qltysh bot reviewed Jan 28, 2026

View reviewed changes

debrisframe/c2TopRunDF/c2TopRunDF.py Show resolved Hide resolved

PaulaSp3 removed a link to an issue Jan 29, 2026

[c2]: modify pyTopRunDF in DebrisFrame? #49

Open

7 tasks

PaulaSp3 requested a review from fso42 January 29, 2026 08:12

add pytest to test if the output is the same as in the original script

2c0c36c

qltysh bot reviewed Jan 29, 2026

View reviewed changes

PaulaSp3 added 2 commits January 29, 2026 10:55

delete simplle test scripts

2aff461

for running pytest with submodule

1f95d5d

fso42 requested changes Feb 9, 2026

View reviewed changes

Conversation

PaulaSp3 commented Jan 28, 2026 • edited by fso42 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

qltysh bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

qltysh bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qltysh bot commented Jan 28, 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!

qltysh bot Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

fso42 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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

PaulaSp3 commented Jan 28, 2026 •

edited by fso42

Loading

qltysh bot commented Jan 28, 2026 •

edited

Loading

qltysh bot commented Jan 28, 2026 •

edited

Loading