com6RockAvalanche: add scarp.py, runCom6Scarp.py & scarpCfg.ini [com6] #1042
Conversation
|
Hello @dwolfsch! Thanks for updating this PR.
Comment last updated at 2024-12-22 09:59:27 UTC |
![qlty-cloud-legacy[bot]](https://avatars.githubusercontent.com/in/9403?s=60&v=4){kind=small}
fso42
left a comment
fso42
left a comment
There was a problem hiding this comment.
Hi @dwolfsch
Thank you for your PR.
I added the first round of review below, but it already looks good.
A general point:
A README or a section in the documentation would be perfect. This should explain the basic usage to make it easier for users what happens and what is needed to run this tool.
If you would rather not touch the documentation, use a README at first, we can then transfer this to the docs.
fso42
changed the title
❌ 2 blocking issues (2 total)
@qltysh one-click actions:
|
![qltysh[bot]](https://avatars.githubusercontent.com/in/890766?s=60&v=4){kind=small}
|
Diff Coverage: The code coverage on the diff in this pull request is 16.2%. Total Coverage: This PR will decrease coverage by 0.67%. File Coverage Changes
🛟 Help
|
|
Standardtests ok |
|
@dwolfsch : please have a look at my changes and the highlighted todos in the code |
|
Code Climate has analyzed commit 52cf71d and detected 3 issues on this pull request. Here's the issue category breakdown:
The test coverage on the diff in this pull request is 16.2% (50% is the threshold). This pull request will bring the total coverage in the repository to 69.2% (-0.5% change). View more on Code Climate. |
- Run file for com6RockAvalanche Scarp - Create scarpCfg.ini - Config-File for scarp.py - Create scarp.py - scarp.py creates scarps, that can be used as an Input for com6RockAvalanche - com6RockAvalanche: update scarp.py, runCom6Scarp.py & scarpCfg.ini, add readme
- Refactored `runCom6Scarp.py` to accept an input directory instead of a configuration file path. - Added TODO comments for further improvements in `scarp.py`, `scarpCfg.ini`, and `runCom6Scarp.py` regarding default parameter handling and output file management. feat(com6RockAvalanche): implement shapefile input for scarp - Implement shapefile input for feature coordinates and perimeter. - Remove raster input options for coordinates and perimeter. - Adapt `scarp.py` to use new input method and updated config. - Adjust `runCom6Scarp.py` to use refactored `scarp.py` functions. - Remove obsolete output paths from config file. docs(scarp): update SCARP documentation with detailed input/output info; remove codeclimate - Add instructions for input files, including elevation DEM and shapefile - Specify output files and their locations in the directory structure - Include steps for preparing the configuration file for scarp calculations - Clarify the usage of the script for running SCARP calculations docs(moduleCom6RockAvalanche): update documentation for scarp calculation refactor(docs): update output paths in moduleCom6RockAvalanche documentation -
https://docs.avaframe.org/en/scarp/moduleCom6RockAvalanche.html