-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature/bypass flow #321
Feature/bypass flow #321
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #321 +/- ##
========================================
Coverage 96.52% 96.53%
========================================
Files 48 48
Lines 2388 2392 +4
========================================
+ Hits 2305 2309 +4
Misses 83 83
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - this makes a lot of sense and that LISFLOOD solution looks very pragmatic. It would be good to add citations and maybe a slightly fuller explanatation of the shape parameter. I didn't really get it until I went to look at
https://ec-jrc.github.io/lisflood-model/2_09_stdLISFLOOD_preferential-bypass
This does need docs to explain it as well - the graph at the bottom of that link is really useful. Is there a separate hydrology docs PR planned?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There is no separate documentation for the hydrology model, I was hoping that the docstrings will cover the most important point and refer to more detailed sources, like LISFLOOD. I'm happy to expand further here (most functions probably need a bit more detailed descriptions as they get established). |
I think we'll need a user-facing doc page for the hydrology model at some point. That should probably explain the features and parameterisation, but that may be for a later date. |
I agree. I will put this on my list and do in a separate PR once all the main features are implemented. |
This PR adds preferential bypass flow, i.e. the flow that bypasses the soil matrix and drains directly to the groundwater. This represents the famous 'pipes'. The shape parameter will need some further investigation and sensitivity analysis.
Type of change
Key checklist
pre-commit
checks:$ pre-commit run -a
$ poetry run pytest
Further checks