[in2TopoHyd]: Module for computing hydraulic inital conditions by JuLa96 · Pull Request #90 · OpenNHM/DebrisFrame

JuLa96 · 2026-08-14T08:46:17Z

in2TopoHyd is an input module for deriving initial hydraulic conditions for the c1TIF computation module
for a debris-flow hydrograph at a prescribed release line. The module combines the topography of the release area with
a time-dependent discharge hydrograph (Topo-Hydrograph) to calculate the corresponding flow thickness and flow velocity at the release line.

The hydraulic conditions are derived from the terrain cross section along the release line.
A rating curve is calculated from the cross-sectional geometry, relating flow thickness to flow area.
For each discharge value of the input hydrograph, the module determines the corresponding mean flow velocity and flow thickness.
The flow thickness is then distributed over the wetted cells of the release cross section.

The resulting initial conditions contain the flow thickness as well as the velocity components in x, y and z direction for every wet cell and every hydrograph timestep.

closes #85

Compiled doc : https://docs.debrisframe.org/en/jl_addtopohydmodule/

initial conditions in time-dependent release mode Add documentation Add test case

qltysh · 2026-08-14T08:47:29Z

❌ 2 blocking issues (2 total)

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

@qltysh one-click actions:

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

qltysh · 2026-08-14T08:48:28Z

Coverage Impact

This PR will not change total coverage.

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

PaulaSp3 · 2026-08-17T07:31:16Z

this file ends with "Levee", below in the documentation it says, the file needs to end with "levee" (lower case).
When running the example, I get this error:

File not found or there are more than one levee files in POINTS-folder!
Ensure that there is exactly one point-shapefile including the ending *levee.shp!

PaulaSp3 · 2026-08-17T09:41:25Z

+
+    return crossSection
+
+def assignRasterCoords(cellSize, releaseLine):


why don't you use avaframe.in3Utils.geoTrans.getCellsAlongLine() instead?

First, I used this function but then I realized that it returns more than one raster center point for a distance station along the release line and this is contradicts the concept of a cross section.
Setting addBuffer = False did not help.

Add test files to default debris-data folder Create separate folders for input data in order to avoid access conflicts modify core functions of the module adapt documentation and config file format documentation

PaulaSp3 · 2026-08-24T06:01:42Z

+    return ratingCurve
+
+
+def computeSlope(dem, crossSection):


Suggested change

def computeSlope(dem, crossSection):

def computeSlopeAlongChannel(dem, crossSection):

PaulaSp3 · 2026-08-24T06:07:35Z

+    # compute two additional cross sections on both handsides of the release line, respectively,
+    # in distance d of original cross section
+    d = 2 * np.sqrt(csz**2 + csz**2)
+    # move starting and ending points of release line in direction of n1 and n2
+    xcoordStart1 = xcoordStart + d * nx1
+    ycoordStart1 = ycoordStart + d * ny1
+    xcoordEnd1 = xcoordEnd + d * nx1
+    ycoordEnd1 = ycoordEnd + d * ny1
+    xcoordStart2 = xcoordStart + d * nx2
+    ycoordStart2 = ycoordStart + d * ny2


is this (and below) the same as in computeSlope() ?
Then I suggest moving that to a separate function.
You could also add d as a parameter to the config file?

PaulaSp3 · 2026-08-24T06:11:34Z

+    return wetCells
+
+
+def plotCrossSection(crossSection, outputDir):


Would it make sense to make another script for plotting functions?

PaulaSp3 · 2026-08-24T06:12:00Z

+
+    ax.plot(crossSection["s"], crossSection["elevation"])
+    ax.scatter(crossSection["sLevee"], crossSection["elevLevee"], color="red", label="Levee points")
+    ax.set_xlabel("distance [m]"), ax.set_ylabel("elevation [m]")


Suggested change

ax.set_xlabel("distance [m]"), ax.set_ylabel("elevation [m]")

ax.set_xlabel("distance [m]")

ax.set_ylabel("elevation [m]")

PaulaSp3 · 2026-08-24T06:12:57Z

+    ax[0].legend()
+
+    ax[1].plot(thickness, flowArea)
+    ax[1].set_xlabel("flow thickness [m]"), ax[1].set_ylabel("flow area [m²]")


Suggested change

ax[1].set_xlabel("flow thickness [m]"), ax[1].set_ylabel("flow area [m²]")

ax[1].set_xlabel("flow thickness [m]")

ax[1].set_ylabel("flow area [m²]")

PaulaSp3 · 2026-08-24T06:20:25Z

+        default="",
+        help="the avalanche/ debris directory",
+    )
+    print(parser)


Suggested change

print(parser)

PaulaSp3 · 2026-08-24T16:37:22Z

+      Inputs/
+        DEM raster file
+        CFGs/     - expert configuration files (optional)
+        REL/      - release line
+        LEVEE/    - levee points


PLease update here the right directories.

PaulaSp3 · 2026-08-24T17:38:04Z

@JuLa96 , @fso42 : I've added in runC1TIF the possibility to compute the c1TIF initial conditions from a hydrograph by executing in2HydTopoMain(). There are still some little open questions (commented as TODO in the code).
(b1c7b51)

There is a related issue (#91), we could/should consider, at least in a separate PR.

fso42

The deletion of the release csv is intentional?

PaulaSp3 · 2026-08-25T16:52:24Z

@fso42: If no timeDependentReleaseScenarios is selected, only one csv file is allowed to be in the REL folder. For the workflow, we want to use the csv file derived from in2TopoHyd.
That's why I've deleted it.
I could modify the timeDependentReleaseScenarios to the name of the derived csv file from in2TopoHyd. What do you mean?

fso42 · 2026-08-26T06:18:24Z

@fso42: If no timeDependentReleaseScenarios is selected, only one csv file is allowed to be in the REL folder. For the workflow, we want to use the csv file derived from in2TopoHyd. That's why I've deleted it. I could modify the timeDependentReleaseScenarios to the name of the derived csv file from in2TopoHyd. What do you mean?

Ah ok, I was just wondering. I would leave it then as it is now

Add in2TopoHyd-module for computing the hydraulic

92420ee

initial conditions in time-dependent release mode Add documentation Add test case

JuLa96 added the enhancement New feature or request label Aug 14, 2026

JuLa96 self-assigned this Aug 14, 2026

JuLa96 requested review from PaulaSp3 and fso42 August 14, 2026 08:46

qltysh Bot reviewed Aug 14, 2026

View reviewed changes

Comment thread debrisframe/in2TopoHyd/in2TopoHyd.py

Comment thread debrisframe/in2TopoHyd/in2TopoHyd.py Outdated

Comment thread debrisframe/in2TopoHyd/in2TopoHyd.py Outdated

Comment thread debrisframe/in2TopoHyd/in2TopoHyd.py Outdated

Comment thread debrisframe/in2TopoHyd/in2TopoHyd.py Outdated

PaulaSp3 requested changes Aug 17, 2026

View reviewed changes

PaulaSp3 reviewed Aug 17, 2026

View reviewed changes

Comment thread debrisframe/in2TopoHyd/in2TopoHyd.py Outdated

PaulaSp3 reviewed Aug 17, 2026

View reviewed changes

Comment thread debrisframe/data/debrisParabolaChanneled/Inputs/HYDR/hydrograph.csv

fso42 requested changes Aug 17, 2026

View reviewed changes

PaulaSp3 requested changes Aug 17, 2026

View reviewed changes

Add sphinxcontrib-bibtex to documentation requirements

dab337a

qltysh Bot reviewed Aug 21, 2026

View reviewed changes

Comment thread debrisframe/in2TopoHyd/in2TopoHyd.py Outdated

Comment thread debrisframe/in2TopoHyd/in2TopoHyd.py Outdated

Comment thread debrisframe/in2TopoHyd/in2TopoHyd.py

Comment thread debrisframe/in2TopoHyd/in2TopoHyd.py

Comment thread docs/source/_static/css/custom.css

add releaseScenario to default c1TIFCfg.ini

7107d3b

Add test files to default debris-data folder Create separate folders for input data in order to avoid access conflicts modify core functions of the module adapt documentation and config file format documentation

JuLa96 force-pushed the JL_AddTopoHydModule branch from 0290d64 to 7107d3b Compare August 21, 2026 12:24

JuLa96 requested review from PaulaSp3 and fso42 August 21, 2026 12:26

fso42 approved these changes Aug 21, 2026

View reviewed changes

PaulaSp3 approved these changes Aug 24, 2026

View reviewed changes

PaulaSp3 requested changes Aug 24, 2026

View reviewed changes

add workflow to compute c1TIF initial conditions from hydrograph

b1c7b51

qltysh Bot reviewed Aug 24, 2026

View reviewed changes

Comment thread debrisframe/in1Utils/fileUtils.py

fso42 requested changes Aug 25, 2026

View reviewed changes

Comment thread debrisframe/runC1TIF.py Outdated

Comment thread debrisframe/runC1TIF.py Outdated

Comment thread debrisframe/runC1TIF.py

Comment thread debrisframe/runC1TIF.py Outdated

comments FSO

51a0942

fso42 approved these changes Aug 26, 2026

View reviewed changes

PaulaSp3 added 3 commits August 26, 2026 13:48

adapt ini for entrainable deposition

068f5be

add meshcellsize to ini and set to 2

294b460

update comment

c199fb4


		return crossSection

		def assignRasterCoords(cellSize, releaseLine):

	def computeSlope(dem, crossSection):
	def computeSlopeAlongChannel(dem, crossSection):

		return wetCells


		def plotCrossSection(crossSection, outputDir):

	ax.set_xlabel("distance [m]"), ax.set_ylabel("elevation [m]")
	ax.set_xlabel("distance [m]")
	ax.set_ylabel("elevation [m]")

	ax[1].set_xlabel("flow thickness [m]"), ax[1].set_ylabel("flow area [m²]")
	ax[1].set_xlabel("flow thickness [m]")
	ax[1].set_ylabel("flow area [m²]")

Uh oh!

Conversation

JuLa96 commented Aug 14, 2026 • edited by fso42 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qltysh Bot commented Aug 14, 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!

qltysh Bot commented Aug 14, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

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!

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!

Uh oh!

PaulaSp3 commented Aug 24, 2026

Uh oh!

fso42 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PaulaSp3 commented Aug 25, 2026

JuLa96 commented Aug 14, 2026 •

edited by fso42

Loading

qltysh Bot commented Aug 14, 2026 •

edited

Loading

fso42 left a comment •

edited

Loading