update DFA path runscript [ana5; runscripts]

[leon-wagner]

With the aim of addressing #848, as well as rework of the runScript

Summary of changes:

• restructured runComputeDFAPath script to make it compatible with QGIS connector, moved script to /avaframe

• the -runDFA flag can now be set to run com1 to generate results for path generation (this was previously handled by a True/False argument within the runScript). The avaFolder may now also be added to the run command.

• settings that are used to override com1DFA run were moved to DFAPath cfg as overrides. changed some of the overrides, path is now essentially generated from a default null com1 run with standard friction and particle settings, and dt=1. path is now also generated from fields as default, instead of from particles.

• if splitpoint is not found with the set angle (default 20 degrees), the splitpoint is now generated at the top of the path, instead of not creating one, to avoid issues down the line. changed plot output accordingly.

• added missing discrete color levels for travel angle, so now colors in the path output plot are generated with the same levels. additionally, color map for travel angles is now Crameri:nuuk (previously was undefined and a mix of Crameri:batlow and Crameri:lapaz)

• also fixes two user warnings in DFAPath script log, one in connection with the legend, one with cmap. also fixed DFA path generation returns no coordinates for splitpoint #1038.

To do:

• [ x ] update documentation with changes. (PR update documentation with changes to DFAPath script [doc] #1051)

[pep8speaks]

Hello @leon-wagner! Thanks for updating this PR.

• In the file avaframe/ana1Tests/energyLineTest.py:

Line 215:121: E501 line too long (152 > 120 characters)
Line 205:22: W605 invalid escape sequence '\D'

• In the file avaframe/ana5Utils/DFAPathGeneration.py:

Line 714:1: E302 expected 2 blank lines, found 1
Line 712:18: E231 missing whitespace after ','
Line 706:121: E501 line too long (127 > 120 characters)
Line 109:1: E302 expected 2 blank lines, found 1
Line 105:16: E231 missing whitespace after ','
Line 89:121: E501 line too long (128 > 120 characters)
Line 68:10: E261 at least two spaces before inline comment
Line 59:74: E127 continuation line over-indented for visual indent
Line 52:13: E117 over-indented
Line 51:13: E117 over-indented (comment)
Line 50:21: E261 at least two spaces before inline comment
Line 32:1: E302 expected 2 blank lines, found 1

• In the file avaframe/in2Trans/shpConversion.py:

Line 420:52: E203 whitespace before ':'
Line 418:48: E203 whitespace before ':'
Line 417:48: E203 whitespace before ':'

• In the file avaframe/out3Plot/outCom3Plots.py:

Line 193:54: E262 inline comment should start with '# '
Line 193:53: E261 at least two spaces before inline comment
Line 175:121: E501 line too long (139 > 120 characters)
Line 170:54: E262 inline comment should start with '# '
Line 170:53: E261 at least two spaces before inline comment
Line 167:121: E501 line too long (122 > 120 characters)
Line 148:54: E262 inline comment should start with '# '
Line 148:53: E261 at least two spaces before inline comment
Line 73:121: E501 line too long (131 > 120 characters)
Line 71:74: E251 unexpected spaces around keyword / parameter equals
Line 71:72: E251 unexpected spaces around keyword / parameter equals
Line 69:93: E251 unexpected spaces around keyword / parameter equals
Line 69:91: E251 unexpected spaces around keyword / parameter equals
Line 69:59: W605 invalid escape sequence '\m'
Line 30:121: E501 line too long (125 > 120 characters)

• In the file avaframe/out3Plot/plotUtils.py:

Line 982:121: E501 line too long (138 > 120 characters)
Line 980:19: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
Line 951:21: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
Line 912:66: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
Line 805:121: E501 line too long (124 > 120 characters)
Line 689:37: E203 whitespace before ':'
Line 688:37: E203 whitespace before ':'
Line 537:15: E711 comparison to None should be 'if cond is not None:'
Line 501:71: E203 whitespace before ':'
Line 501:48: E203 whitespace before ':'
Line 495:71: E203 whitespace before ':'
Line 495:48: E203 whitespace before ':'
Line 482:121: E501 line too long (121 > 120 characters)

• In the file avaframe/runAna5DFAPathGeneration.py:

Line 86:1: E305 expected 2 blank lines after class or function definition, found 1
Line 84:19: E231 missing whitespace after ','
Line 21:1: E302 expected 2 blank lines, found 1

• In the file avaframe/tests/test_DFAPathGeneration.py:

Line 112:5: E303 too many blank lines (2)
Line 72:20: E262 inline comment should start with '# '
Line 72:20: E261 at least two spaces before inline comment

Comment last updated at 2024-12-09 10:51:25 UTC

[codecov]

Codecov Report

Attention: Patch coverage is 21.78218% with 79 lines in your changes missing coverage. Please review.

Project coverage is 73.54%. Comparing base (eea271a) to head (3ef7697).
Report is 68 commits behind head on master.

Files with missing lines	Patch %	Lines
avaframe/ana5Utils/DFAPathGeneration.py	20.00%	40 Missing ⚠️
avaframe/out3Plot/outCom3Plots.py	0.00%	35 Missing ⚠️
avaframe/in2Trans/shpConversion.py	72.72%	3 Missing ⚠️
avaframe/com3Hybrid/com3Hybrid.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1039      +/-   ##
==========================================
- Coverage   73.82%   73.54%   -0.29%     
==========================================
  Files          66       66              
  Lines       14916    15439     +523     
==========================================
+ Hits        11012    11354     +342     
- Misses       3904     4085     +181     

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

[codeclimate]

Code Climate has analyzed commit 9191d8a and detected 6 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	4
Duplication	2

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

This pull request will bring the total coverage in the repository to 69.5%.

View more on Code Climate.

[fso42]

Standardtests ok, apart from known