[com4FlowPy] minor Bugfix, documentation update and added feature for "forestFriciton", "forestDetrainment" and "forestFrictionLayer" model options by ahuber-bfw · Pull Request #1071 · OpenNHM/AvaFrame

ahuber-bfw · 2025-01-21T15:08:33Z

fixed minor bug in runCom4FlowPy.py that caused an unhandled exception if the workDir did not exist a priori with useCustomPaths option set to True
updated com4FlowPy documentation (additional references, and small changes)
new Feature/modelOption skipForestDist:
- skipForestDist allows the definition of a length [m] along the track (calculated in X,Y,Z and not in projected distances X,Y- to account for different track inclinations) that needs to be surpassed, before added forestFriction is modeled. This affects all forestFriction related code if forestFriction, forestFrictionLayer or forestDetrainment are selected.
- the feature allows to define an "initial acceleration distance" for GMFs that release in or directly above dense forest and should provide a mechanism to prevent potential under-estimation of GMF runouts in these cases.
- By leaving the default value skipForestDist = 0 the prior model behavior remains unchanged.
note: This makes the code ~ 5% to 10% slower in first tests

…pForestDist [m]

…t exit a priori

pep8speaks · 2025-01-21T15:08:41Z

Hello @ahuber-bfw! Thanks for updating this PR.

In the file avaframe/com4FlowPy/com4FlowPy.py:

Line 565:121: E501 line too long (121 > 120 characters)
Line 344:121: E501 line too long (121 > 120 characters)

In the file avaframe/com4FlowPy/flowCore.py:

Line 561:121: E501 line too long (124 > 120 characters)

Comment last updated at 2025-01-23 18:07:17 UTC

…pForestDist [m]

…t exit a priori

avaframe/com4FlowPy/flowClass.py

avaframe/com4FlowPy/flowCore.py

docs/moduleCom4FlowPy.rst

PaulaSp3

Nice function.
I haven't tested it a lot, I recognized larger zDelta - values with a longer skipForestDist (when computing with forestFriction).

avaframe/com4FlowPy/flowClass.py

Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com>

…ub.com/avaframe/AvaFrame into AH_com4FlowPy_improvForestFricitonDist

qlty-cloud-legacy

The PR diff size of 10820 lines exceeds the maximum allowed for the inline comments feature.

codecov · 2025-02-11T14:01:22Z

Codecov Report

Attention: Patch coverage is 72.98797% with 292 lines in your changes missing coverage. Please review.

Project coverage is 73.56%. Comparing base (eea271a) to head (846037d).
Report is 90 commits behind head on master.

Files with missing lines	Patch %	Lines
avaframe/out3Plot/outParticlesAnalysis.py	29.06%	122 Missing ⚠️
avaframe/in3Utils/generateTopo.py	73.21%	45 Missing ⚠️
avaframe/com1DFA/deriveParameterSet.py	80.48%	40 Missing ⚠️
avaframe/in3Utils/fileHandlerUtils.py	83.42%	29 Missing ⚠️
avaframe/in3Utils/geoTrans.py	91.15%	13 Missing ⚠️
avaframe/out1Peak/outPlotAllPeak.py	64.86%	13 Missing ⚠️
avaframe/out3Plot/outQuickPlot.py	46.15%	7 Missing ⚠️
avaframe/ana1Tests/testUtilities.py	80.00%	5 Missing ⚠️
avaframe/in2Trans/ascUtils.py	0.00%	5 Missing ⚠️
avaframe/ana1Tests/FPtest.py	0.00%	2 Missing ⚠️
... and 8 more

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1071      +/-   ##
==========================================
- Coverage   73.82%   73.56%   -0.26%     
==========================================
  Files          66       67       +1     
  Lines       14916    15621     +705     
==========================================
+ Hits        11012    11492     +480     
- Misses       3904     4129     +225

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

author PaulaSp3 <paula.spannring@gmail.com> 1737114502 +0100 committer ahuber-bfw <andreas.huber@bfw.gv.at> 1739289947 +0100 parent a638226 author PaulaSp3 <paula.spannring@gmail.com> 1737114502 +0100 committer ahuber-bfw <andreas.huber@bfw.gv.at> 1739289880 +0100 parent a638226 author PaulaSp3 <paula.spannring@gmail.com> 1737114502 +0100 committer ahuber-bfw <andreas.huber@bfw.gv.at> 1739289804 +0100 parent a638226 author PaulaSp3 <paula.spannring@gmail.com> 1737114502 +0100 committer ahuber-bfw <andreas.huber@bfw.gv.at> 1739289200 +0100 parent a638226 author PaulaSp3 <paula.spannring@gmail.com> 1737114502 +0100 committer ahuber-bfw <andreas.huber@bfw.gv.at> 1739288900 +0100 zDeltaSum computed as sum of paths, for every path the max is computed in every cell remove setting label for contourline at collections update docu ana5Utils DFAPath optionally: move Automated path generation above Distance-Time Analysis Add gdal related dependencies. rasterio, geopandas, fiona - add basemap to plot; rename ascUtils to rasterUtils - start inclusion of geotiff; working commit, squash - add cropshape option in plotAll - add alr tif Add resampling using rasterio - rework new remesh to reproduce old remeshing - update reference remesh file for pytest test_geoTrans - remove unecessary code and test -> if raster is found with correct size, it already returns. There is no need for an overwrite then Update parts to .asc and .tif compatibility - Fixes deriveParameterSet pytests - make search for sim and comp file (standard test) tif compatible - add pytest-mock to runTestSinglePython.yml action - This commit also updates the Code Climate action to version 9.0.0. - add check if CRS is none if online background flag is true - error BREAKING CHANGES: Removed the `plotASCwithWmts` function and the `plotPeaksWithMap.py` file. This functionality is no longer required. Improve input file handling: adds 'raster' option to getAndCheckInputFiles add getInput pytests feat(in2Trans): readd ascUtils module (addGdalStuff) This commit readds the `ascUtils` module, which provides functionality for reading and writing ASCII grid files. All functions include deprecation warnings, directing users to the `rasterUtils` module for replacements. Upgrade twine and install pkginfo before upload update to com4FlowPy documentation fixed minor log BUG in runCom4.. + replaces nSkipForestCells with skipForestDist [m] creation of custom WorkDir - fixed Bug with logfile if workDir doesn't exit a priori minor re-write of forestFriction part of calc_z_delta() minor code clean-up code style fixed minor log BUG in runCom4.. + replaces nSkipForestCells with skipForestDist [m] Update docs/moduleCom4FlowPy.rst Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com> Update docs/moduleCom4FlowPy.rst Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com> Update avaframe/com4FlowPy/flowClass.py Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com> Apply suggestions from code review Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com> deleted note in moduleCom4FlowPy.rst documentation finle review suggestion fixed minor log BUG in runCom4.. + replaces nSkipForestCells with skipForestDist [m] creation of custom WorkDir - fixed Bug with logfile if workDir doesn't exit a priori minor code clean-up code style fixed minor log BUG in runCom4.. + replaces nSkipForestCells with skipForestDist [m] creation of custom WorkDir - fixed Bug with logfile if workDir doesn't exit a priori minor code clean-up code style Update docs/moduleCom4FlowPy.rst Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com> Update avaframe/com4FlowPy/flowClass.py Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com> deleted note in moduleCom4FlowPy.rst documentation finle review suggestion deleted 1 line in runCom4FlowPy.py

…' of https://github.com/avaframe/AvaFrame into AH_com4FlowPy_improvForestFricitonDist

qlty-cloud-legacy · 2025-02-11T16:21:26Z

Code Climate has analyzed commit 2769065 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 9.3% (50% is the threshold).

This pull request will bring the total coverage in the repository to 69.2% (0.0% change).

View more on Code Climate.

fso42 · 2025-02-12T14:44:43Z

Closed in favor of #1087

ahuber-bfw added 5 commits January 16, 2025 18:49

update to com4FlowPy documentation

a638226

fixed minor log BUG in runCom4.. + replaces nSkipForestCells with ski…

12d9eae

…pForestDist [m]

creation of custom WorkDir - fixed Bug with logfile if workDir doesn'…

a7d306a

…t exit a priori

minor re-write of forestFriction part of calc_z_delta()

b70b4f7

minor code clean-up

5bfe888

ahuber-bfw added confirmed Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Jan 21, 2025

ahuber-bfw requested a review from PaulaSp3 January 21, 2025 15:08

ahuber-bfw added 8 commits January 21, 2025 16:14

code style

c034ffd

update to com4FlowPy documentation

5cb2663

fixed minor log BUG in runCom4.. + replaces nSkipForestCells with ski…

8f7ac5f

…pForestDist [m]

creation of custom WorkDir - fixed Bug with logfile if workDir doesn'…

c5533f6

…t exit a priori

minor re-write of forestFriction part of calc_z_delta()

39a00a9

minor code clean-up

eebcb0b

code style

5ac79c6

Rebase wit Master

090f3bb

PaulaSp3 requested changes Jan 23, 2025

View reviewed changes

PaulaSp3 reviewed Jan 23, 2025

View reviewed changes

PaulaSp3 requested changes Jan 23, 2025

View reviewed changes

avaframe/com4FlowPy/flowClass.py Show resolved Hide resolved

ahuber-bfw and others added 2 commits January 23, 2025 16:57

Update docs/moduleCom4FlowPy.rst

2a4b6cf

Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com>

Update docs/moduleCom4FlowPy.rst

37ecd56

Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com>

ahuber-bfw assigned ahuber-bfw and PaulaSp3 Jan 23, 2025

ahuber-bfw and others added 4 commits January 23, 2025 18:12

Update avaframe/com4FlowPy/flowClass.py

a750084

Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com>

Apply suggestions from code review

eac1d84

Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com>

deleted note in moduleCom4FlowPy.rst documentation finle

304f515

review suggestion

f44ac51

PaulaSp3 self-requested a review January 24, 2025 09:43

ahuber-bfw and others added 8 commits February 11, 2025 14:38

Update docs/moduleCom4FlowPy.rst

3c647ed

Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com>

Update docs/moduleCom4FlowPy.rst

1fcbbde

Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com>

Update avaframe/com4FlowPy/flowClass.py

3b29a6d

Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com>

Apply suggestions from code review

193caf6

Co-authored-by: Paula Spannring <95042192+PaulaSp3@users.noreply.github.com>

deleted note in moduleCom4FlowPy.rst documentation finle

193b1d9

review suggestion

98e6ecc

Merge branch 'AH_com4FlowPy_improvForestFricitonDist' of https://gith…

e4c2ce6

…ub.com/avaframe/AvaFrame into AH_com4FlowPy_improvForestFricitonDist

deleted 1 line in runCom4FlowPy.py

846037d

qlty-cloud-legacy bot reviewed Feb 11, 2025

View reviewed changes

PaulaSp3 and others added 2 commits February 11, 2025 17:06

Squash commits - Merge branch 'AH_com4FlowPy_improvForestFricitonDist…

2769065

…' of https://github.com/avaframe/AvaFrame into AH_com4FlowPy_improvForestFricitonDist

ahuber-bfw assigned fso42 and unassigned fso42, PaulaSp3 and ahuber-bfw Feb 11, 2025

ahuber-bfw added a commit that referenced this pull request Feb 12, 2025

manually applied PR #1071 on top of current master

8694a8f

ahuber-bfw mentioned this pull request Feb 12, 2025

[com4FlowPy] minor Bugfix, documentation update and added feature for "forestFriciton", "forestDetrainment" and "forestFrictionLayer" model options #1087

Merged

fso42 closed this Feb 12, 2025

fso42 pushed a commit that referenced this pull request Feb 19, 2025

manually applied PR #1071 on top of current master

022f69c

fso42 pushed a commit that referenced this pull request Feb 20, 2025

manually applied PR #1071 on top of current master

02a2b1d

fso42 pushed a commit that referenced this pull request Feb 20, 2025

manually applied PR #1071 on top of current master

4a0257c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[com4FlowPy] minor Bugfix, documentation update and added feature for "forestFriciton", "forestDetrainment" and "forestFrictionLayer" model options#1071

[com4FlowPy] minor Bugfix, documentation update and added feature for "forestFriciton", "forestDetrainment" and "forestFrictionLayer" model options#1071
ahuber-bfw wants to merge 36 commits intomasterfrom
AH_com4FlowPy_improvForestFricitonDist

ahuber-bfw commented Jan 21, 2025

Uh oh!

pep8speaks commented Jan 21, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PaulaSp3 left a comment

Uh oh!

Uh oh!

qlty-cloud-legacy bot left a comment

Uh oh!

codecov bot commented Feb 11, 2025

Uh oh!

qlty-cloud-legacy bot commented Feb 11, 2025

Uh oh!

fso42 commented Feb 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

ahuber-bfw commented Jan 21, 2025

Uh oh!

pep8speaks commented Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comment last updated at 2025-01-23 18:07:17 UTC

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PaulaSp3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

qlty-cloud-legacy bot left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Feb 11, 2025

Codecov Report

Uh oh!

qlty-cloud-legacy bot commented Feb 11, 2025

Uh oh!

fso42 commented Feb 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pep8speaks commented Jan 21, 2025 •

edited

Loading