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

rename model files #690

Merged
merged 3 commits into from
Oct 21, 2023
Merged

rename model files #690

merged 3 commits into from
Oct 21, 2023

Conversation

visr
Copy link
Member

@visr visr commented Oct 20, 2023

Fixes a large part of #638. Not entirely, I listed two follow-ups that are probably best done after #630 in that issue.
This also removes the model name from the model, as before the only thing it did was name the TOML and GeoPackage.
That meant I had to adapt ribasim_testmodels a bit to expose a constructors dict which maps the test model names to the constructor functions.

https://github.com/Deltares/Ribasim/compare/names?expand=1#diff-b223bf31f9400e170f97d95fa1d8b22393e5d37cfd810a4a5aa7bf480915ac52

This doesn't just change the file names but also updates the documentation to stop talking about GeoPackage so much and consistently refer to the database. Also QGIS panel names are updated, function, class and variable names.

Breaking changes
TOML section names are updated, so this is breaking. Specifically, the geopackage key is now called database, and the [output] section is now called [results]. The default output folder is now also called results.

@visr visr added the breaking A change that breaks existing models label Oct 20, 2023
@visr visr mentioned this pull request Oct 20, 2023
3 tasks
@visr visr merged commit c710ed2 into main Oct 21, 2023
15 checks passed
@visr visr deleted the names branch October 21, 2023 13:50
@Hofer-Julian Hofer-Julian mentioned this pull request Oct 23, 2023
visr pushed a commit that referenced this pull request Oct 23, 2023
visr added a commit that referenced this pull request Oct 25, 2023
Fixes a large part of #638. Not entirely, I listed two follow-ups that
are probably best done after #630 in that issue.
This also removes the model name from the model, as before the only
thing it did was name the TOML and GeoPackage.
That meant I had to adapt `ribasim_testmodels` a bit to expose a
`constructors` dict which maps the test model names to the constructor
functions.


https://github.com/Deltares/Ribasim/compare/names?expand=1#diff-b223bf31f9400e170f97d95fa1d8b22393e5d37cfd810a4a5aa7bf480915ac52

This doesn't just change the file names but also updates the
documentation to stop talking about GeoPackage so much and consistently
refer to the database. Also QGIS panel names are updated, function,
class and variable names.

TOML section names are updated, so this is breaking. Specifically, the
`geopackage` key is now called `database`, and the `[output]` section is
now called `[results]`. The default output folder is now also called
results.
visr pushed a commit that referenced this pull request Oct 25, 2023
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
None yet
Development

Successfully merging this pull request may close these issues.

2 participants