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

Update data conventions on names and units #736

Draft
wants to merge 3 commits into
base: v1
Choose a base branch
from
Draft

Conversation

hboisgon
Copy link
Contributor

Issue addressed

Fixes #45

Explanation

After a first discussion, we decided to have names of variables in hydromt be more explicit and a few new variables were added after review of existing plugins (wflow, sfincs, delwaq, delft3dfm)

To update conventions, need to:

  • define them in the docs
  • update the pre-defined catalogs (including artifact_data if possible)
  • update the mentions in the code, especially the workflows and their docstrings

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
  • For predefined catalogs: update the catalog version in the file itself, the references in data/predefined_catalogs.yml, and the changelog in data/changelog.rst

Additional Notes (optional)

Add any additional notes or information that may be helpful.

@savente93
Copy link
Contributor

@hboisgon do you think it will be feasible to include this in the alpha?

@hboisgon
Copy link
Contributor Author

Not sure anymore. In this PR I would need to update the data catalogs but I don't know if it is a good idea to do it before PR #833 is merged?

@savente93
Copy link
Contributor

Ah okay, I didn't realize the data catalogs needed to be updated. Then we can leave it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants