Improvements to the base documentation #274
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Zeitsperre
approved these changes
Mar 24, 2025
for more information, see https://pre-commit.ci
# Conflicts: # docs/notebooks/gis.ipynb
…notebooks (#278) <!-- 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: - [ ] This PR addresses an already opened issue (for bug fixes / features) - This PR fixes #xyz - [ ] (If applicable) Documentation has been added / updated (for bug fixes / features). - [ ] (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? * The optimal interpolation notebook was quite strange, since the first example was very thorough, but used bad data and, thus, produced bad results. I removed that example and moved the theory at the start. * I split the modelling notebook in 2. One for Raven, one for Hydrotel. * `DummyModel` was dropped. We don't need it anymore and it can be confusing to have it there at the same level as other models. * I did the bare minimum to fix the output of the optimal interpolation, but there is something quite wrong with the code... #277 ### Does this PR introduce a breaking change? ### Other information:
<!-- 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: - [ ] This PR addresses an already opened issue (for bug fixes / features) - This PR fixes #xyz - [ ] (If applicable) Documentation has been added / updated (for bug fixes / features). - [ ] (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? * Multiple improvements to the text for the notebooks related to GIS features and frequency analysis. * I tried to make the GIS notebook smaller in computation time. We will see if it can now be run on RtD. ### Does this PR introduce a breaking change? * Many arguments are now literal instead of positional. ### Other information:
<!-- 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: - [ ] This PR addresses an already opened issue (for bug fixes / features) - This PR fixes #xyz - [ ] (If applicable) Documentation has been added / updated (for bug fixes / features). - [ ] (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? * Various improvements to the text within the PMP and Extreme Value Analysis ntoebooks. ### Does this PR introduce a breaking change? * Many arguments in `pmp.py` have been made literal instead of positional. ### Other information:
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist:
number) and pull request (:pull:number) has been added.What kind of change does this PR introduce?
docs/index.rstfile, providing quick access to the GitHub repository, PyPI package, and Conda package.This pull request includes various updates to documentation and configuration files aimed at improving clarity, updating dependencies, and ensuring consistent naming conventions. The most important changes are summarized below:
Does this PR introduce a breaking change?
Other information:
_simple_modelswhich was meant for another PR. This will break the docs and tests, but oh well. We just have to merge this after.