hydrologie / xhydro / 16946115354

92%

push

github

Methods to update existing RavenpyModel  (#341)

<!-- 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 #xyz
- [x] (If applicable) Documentation has been added / updated (for bug
fixes / features).
- [x] If changes affect the GIS, Raven Modelling, Extremes.jl or Use
Case Example notebooks, they have been re-run (ReadTheDocs will not
update these).
- [x] If text has changed, ``make initialize-translations`` /
``make-translations.bat`` has been run and translations have been
updated.
- [x] (If applicable) Tests have been added.
- [x] CHANGELOG.rst has been updated (with summary of main changes).
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added.

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

* All model characteristics are now stored as attributes.
* A new class function, `update_data`, can be used to update the
observed streamflow, HRU characteristics and meteorological data
correctly.
* The code that was in `create_rv` has been moved to smaller
self-contained functions to update `.qobs`, `.hru`, `.meteo`.
* A new class function `update_config` can now be used to update some
simpler options directly in the `.rv*` files, such as the start and end
dates, the meteorological files, or the subbasins to output.
* An `executable` argument has been added to the `.run()` function to
bypass the Raven version of the active Python environment.

### Does this PR introduce a breaking change?

* It should not. The PR looks scary, but it's mostly because `create_rv`
has been split into multiple smaller functions. Most arguments have been
removed from `create_rv`, but it should still be fully
backwards-compatible.


### Other information:

298 of 307 new or added lines in 1 file covered. (97.07%)

2869 of 3084 relevant lines covered (93.03%)

4.11 hits per line