Add contour line plot [com1; ana5; out3; breaking change]

[awirb]

• add a contour line plot for peak files
• runScript example

Breaking change for override sections: now need the collection name as well as the module name

• add info to documentation

[codecov]

Codecov Report

Attention: 43 lines in your changes are missing coverage. Please review.

Comparison is base (3e709e4) 73.92% compared to head (cb67a4b) 73.88%.

Files	Patch %	Lines
avaframe/out3Plot/outQuickPlot.py	44.44%	25 Missing ⚠️
avaframe/in3Utils/cfgHandling.py	91.50%	9 Missing ⚠️
avaframe/com3Hybrid/com3Hybrid.py	0.00%	7 Missing ⚠️
avaframe/ana5Utils/distanceTimeAnalysis.py	50.00%	1 Missing ⚠️
avaframe/out1Peak/outPlotAllPeak.py	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #953      +/-   ##
==========================================
- Coverage   73.92%   73.88%   -0.05%     
==========================================
  Files          64       64              
  Lines       14675    14755      +80     
==========================================
+ Hits        10848    10901      +53     
- Misses       3827     3854      +27     

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

[pep8speaks]

Hello @awirb! Thanks for updating this PR.

• In the file avaframe/ana4Stats/probAna.py:

Line 800:121: E501 line too long (129 > 120 characters)
Line 693:121: E501 line too long (135 > 120 characters)
Line 692:121: E501 line too long (167 > 120 characters)
Line 628:121: E501 line too long (127 > 120 characters)
Line 470:121: E501 line too long (128 > 120 characters)
Line 399:121: E501 line too long (121 > 120 characters)
Line 188:121: E501 line too long (135 > 120 characters)

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

Line 314:9: E265 block comment should start with '# '
Line 313:9: E265 block comment should start with '# '
Line 312:9: E265 block comment should start with '# '

• In the file avaframe/in3Utils/cfgHandling.py:

Line 386:42: E712 comparison to True should be 'if cond is True:' or 'if cond:'
Line 383:42: E712 comparison to False should be 'if cond is False:' or 'if not cond:'

• In the file avaframe/in3Utils/cfgUtils.py:

Line 815:28: W292 no newline at end of file
Line 627:50: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
Line 313:37: E231 missing whitespace after ','
Line 92:38: E712 comparison to False should be 'if cond is False:' or 'if not cond:'

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

Line 165:48: E712 comparison to False should be 'if cond is False:' or 'if not cond:'

• In the file avaframe/runScripts/runEnergyLineTest.py:

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

• In the file avaframe/runScripts/runParticleAnalysisPlots.py:

Line 133:121: E501 line too long (138 > 120 characters)
Line 95:1: E265 block comment should start with '# '
Line 94:121: E501 line too long (128 > 120 characters)
Line 41:1: E266 too many leading '#' for block comment
Line 31:1: E266 too many leading '#' for block comment

• In the file avaframe/runScripts/runPlotContoursFromAsc.py:

Line 37:1: W391 blank line at end of file

• In the file avaframe/runScripts/runRotationTest.py:

Line 59:121: E501 line too long (124 > 120 characters)
Line 54:121: E501 line too long (138 > 120 characters)
Line 48:121: E501 line too long (122 > 120 characters)

• In the file avaframe/runStandardTestsCom1DFA.py:

Line 103:121: E501 line too long (127 > 120 characters)

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

Line 197:121: E501 line too long (128 > 120 characters)

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

Line 444:121: E501 line too long (122 > 120 characters)
Line 117:64: E712 comparison to False should be 'if cond is False:' or 'if not cond:'

Comment last updated at 2024-01-23 15:49:26 UTC

[fso42]

I think it would be necessary to explain the override logic in our documentation...

[qlty-cloud-legacy]

Code Climate has analyzed commit cb67a4b and detected 2 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	2

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

This pull request will bring the total coverage in the repository to 73.8% (-0.1% change).

View more on Code Climate.

[fso42]

Standardtests ok, apart from avaKot

[fso42]

avaKot is related to change here: #948, accepting for now (new DEM data basis, reporjection ...). Benchmark results need to be updated.