Skip to content
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

Add examples #85

Merged
merged 19 commits into from
Oct 20, 2023
Merged

Add examples #85

merged 19 commits into from
Oct 20, 2023

Conversation

hboisgon
Copy link
Contributor

@hboisgon hboisgon commented Sep 22, 2023

Issue addressed

Fixes #54 , #96

Explanation

Add a couple of examples to the documentation:

  • general part, see README.rst
  • Build 1d model notebook
  • Build 2d model notebook
  • build 1d2d model notebook
  • update 1d model with 2d model and 1d2d links notebook
  • update 1d model with structures
  • update 'refine' grid of 2d model notebook
  • update default boundaries with timeseries notebook
  • plot model mesh

Checklist

  • Updated tests or added new tests
  • Branch is up to date with main
  • Tests & pre-commit hooks pass
  • Updated documentation if needed
  • Updated changelog.rst if needed

@hboisgon hboisgon self-assigned this Sep 22, 2023
@hboisgon
Copy link
Contributor Author

I changed some settings in setup_rivers_from_dem, basically the buffer is more needed to read the rivers data than the dem grid (I found that when trying to build a model in Africa). But seems that maybe the tests fail because of it. @xldeltares, does the error look familiar? If it's really due to this change we can also cancel and open an issue to update later.

@xldeltares
Copy link
Collaborator

xldeltares commented Oct 20, 2023

TODO:

  • merge main into branch
  • check the plot example
  • clean all my notebook results for recommit
  • update change log
  • update the version v0.1.2 (next release) in the installation guide; add a line points to installation guide that contains anaconda/mamba install
  • remove mesh folder from the examples ipynotebook
  • check why the example piave fails
  • there is also changes in the mesh_utils.
  • After merging, reopen an issue with remaining examples todos
  • update hydromt 0.9.0

@sonarcloud
Copy link

sonarcloud bot commented Oct 20, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@xldeltares xldeltares merged commit 5465929 into main Oct 20, 2023
6 of 7 checks passed
@xldeltares xldeltares deleted the 54-examples branch October 20, 2023 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create documentation examples
2 participants