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

Dsd 24 preparations #202

Merged
merged 16 commits into from
Nov 6, 2024
Merged

Dsd 24 preparations #202

merged 16 commits into from
Nov 6, 2024

Conversation

shartgring
Copy link
Collaborator

Issue addressed

Fixes #201

Explanation

Explain how you addressed the bug/feature request, what choices you made and why.

Checklist

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

Additional Notes (optional)

For the DSD 2024. The demo will be on Monday the 11th in the afternoon

Copy link
Contributor

@hboisgon hboisgon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @shartgring
Very nice introduction example! HydroMT core or more plugins could re-use it :)

A few notes left still:

  • usually the notebooks are stored on git without results so that when users download them they do not get your results in their notebooks. When building the docs, then the notebooks will be executed and the results will show. Leading to:
  • you may want to integrate this notebook in the docs. You have the list of examples: docs/getting_started/example_index.rst
  • and usually an extra page for example in how to build a model: docs/user_guide/dflowfm_build.rst

I did not run the notebook myself but I saw your results and there's not so muc code that can go wrong so I assume this is okay!

examples/hydromt_tutorial.ipynb Outdated Show resolved Hide resolved
@shartgring
Copy link
Collaborator Author

Hi @shartgring Very nice introduction example! HydroMT core or more plugins could re-use it :)

A few notes left still:

  • usually the notebooks are stored on git without results so that when users download them they do not get your results in their notebooks. When building the docs, then the notebooks will be executed and the results will show. Leading to:
  • you may want to integrate this notebook in the docs. You have the list of examples: docs/getting_started/example_index.rst
  • and usually an extra page for example in how to build a model: docs/user_guide/dflowfm_build.rst

I did not run the notebook myself but I saw your results and there's not so muc code that can go wrong so I assume this is okay!

Good points, thanks! I will also walk with Vera through the code in a couple of minutes so that will also be a good test to see if no errors appear. I have included the new notebook in the docs and also fixed some types when doing it (as part of #198)

Copy link
Contributor

@hboisgon hboisgon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link

sonarcloud bot commented Nov 6, 2024

@shartgring shartgring merged commit 2540e7f into main Nov 6, 2024
7 checks passed
@shartgring shartgring deleted the dsd-24-preparations branch November 6, 2024 09:51
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.

New notebook with step-by-step HydroMT usage
2 participants