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

Renaming Basin, Edge and possibly more #1960

Open
visr opened this issue Dec 5, 2024 · 0 comments
Open

Renaming Basin, Edge and possibly more #1960

visr opened this issue Dec 5, 2024 · 0 comments
Labels
breaking A change that breaks existing models

Comments

@visr
Copy link
Member

visr commented Dec 5, 2024

Before Ribasim becomes more widely used, it is good to consider feedback from new users. One such feedback is that some names we use may cause some confusion.

Edge
Why: The name Edge is commonly used in graph theory, but is not so common in hydrological modeling.
Alternatives: Link.

Basin
Why: Basin's don't necessarily need to align with basins or watersheds. Basins always need some explanation of them representing (a part of a) water body with a certain storage and level.
Alternatives:

  • Waterbody: We should try to think ahead if this would still make sense if we will add other node types representing water bodies, like Add Confluence node #1609 or reservoirs.
  • LevelPool was mentioned by Joe Hughes. I see this used in Surface-Water Routing (SWR) docs, and see references like in HEC-RAS docs.
  • Reach, used in SWR and other software, makes it clear that it is a part of a river or stream.
  • LevelStorage
  • ...

Implementation

These renames can be very breaking for users, which is a reason not to wait too long. Though doing them right now isn't great for https://github.com/Deltares/Ribasim-NL progress. Ribasim Python migration can do the renames, and potentially offer the old names as API aliases temporarily. The core could have a period in which it looks for the old table names if the new ones don't exist.

Note: Implementation can also have an impact on the BMI and thus the coupling with MFMS

@visr visr added the breaking A change that breaks existing models label Dec 5, 2024
@github-project-automation github-project-automation bot moved this to To do in Ribasim Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking A change that breaks existing models
Projects
Status: To do
Development

No branches or pull requests

1 participant