hydrologie / xhydro / 13865518722

92%

Build Type

push

github

Committed by web-flow

Commit Message

Add a Use Case example and fix kernel crashes (#268)

<!-- Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
  - This PR fixes #265 
- [x] (If applicable) Documentation has been added / updated (for bug
fixes / features).
- [x] (If applicable) Tests have been added.
- [ ] CHANGELOG.rst has been updated (with summary of main changes).
- [ ] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added.

### What kind of change does this PR introduce?

* Add a use case example.
* Changes how observations are managed when using the calibration module
and RavenPy models.

### Does this PR introduce a breaking change?

* `qobs` and `qobs_path` have been completely removed from the
`RavenpyModel` class, since it was never used, but likely created issues
in some systems by both opening the NetCDF file and asking `rapenpy` to
also do the same.
* Instead, `qobs` has been moved to `perform_calibration`, which is the
more logical place.
* I could see an argument to keep `qobs` as an optional input to more
easily compute objective functions, if we add that function to the
classes: `model.get_objective_function("kge", time=slice("1991",
"2020"))` or something like that.


### Other information:

* Ideally this would have been 2 PRs, but I kinda had to fix the issue
for my Notebook to run...

* I tried to be as accurate as possible with the example, so the
Notebook is way too heavy to be run by RtD. This will have to be updated
manually from time to time.

Run Details

4 of 16 new or added lines in 2 files covered. (25.0%)

1 existing line in 1 file now uncovered.

2418 of 2587 relevant lines covered (93.47%)

3.38 hits per line