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

documentation - hydromt data input - harmonize conventions for data names and units between the different plugins #45

Open
couasnonanais opened this issue Jun 7, 2021 · 5 comments · May be fixed by #736
Assignees
Labels
Blocked An issue that cannot be progressed right now Documentation Improvements or additions to documentation V1
Milestone

Comments

@couasnonanais
Copy link
Contributor

The page for data convention does mention discharge but this information listed there does not include the case described in the function SfincsModel.setup_q_forcing(). This function requires the netcdf discharge data to have the variable name 'discharge'

@hboisgon
Copy link
Contributor

hboisgon commented Jun 7, 2021

Thanks for your remark @couasnonanais

This is actually a larger problem we should address and really look out for when including more and more model plugins.
We should harmonize data names and conventions better within the development team.

For now you can always refer to the specific documentation of the component you want to use. They are the most up-to-date and specifically mention the required (and optional) variables expected from your data.
In your case: https://deltares.github.io/hydromt_sfincs/latest/generated/hydromt_sfincs.sfincs.SfincsModel.setup_q_forcing.html#hydromt_sfincs.sfincs.SfincsModel.setup_q_forcing

If you don't mind I'll rename your issue to reflect the 'bigger' problem here.

@hboisgon hboisgon changed the title documentation - hydromt data input - convention for discharge missing? documentation - hydromt data input - harmonize conventions for data names and units between the different plugins Jun 7, 2021
@hboisgon
Copy link
Contributor

hboisgon commented Jun 7, 2021

The harmonization of conventions for data names and units is particularly important if we want to keep the same yml libraries for the global data used by different model plugins

@hboisgon hboisgon added the Documentation Improvements or additions to documentation label Jun 8, 2021
@alimeshgi alimeshgi added this to the Q3 milestone Jun 21, 2023
@savente93 savente93 added the Blocked An issue that cannot be progressed right now label Oct 5, 2023
@savente93 savente93 modified the milestones: Q3, Q4 Oct 9, 2023
@savente93 savente93 removed the Blocked An issue that cannot be progressed right now label Oct 19, 2023
@savente93 savente93 added the Blocked An issue that cannot be progressed right now label Nov 14, 2023
@savente93
Copy link
Contributor

I made a template for the plugins to note down their variable names and units. Ali has agreed to coordinate the plugins filling this in. Will pick this back up when the responses are in.

@savente93 savente93 self-assigned this Nov 14, 2023
@savente93 savente93 assigned DirkEilander and unassigned savente93 Nov 28, 2023
@DirkEilander DirkEilander assigned hboisgon and unassigned DirkEilander Dec 4, 2023
@savente93 savente93 added the Spillover Issues that were planned but not completed last quarter label Jan 8, 2024
@savente93 savente93 modified the milestones: 2023 - Q4, 2024 - Q1 Jan 8, 2024
@savente93 savente93 removed the Spillover Issues that were planned but not completed last quarter label Jan 10, 2024
@savente93 savente93 modified the milestones: 2024 - Q1, v1.0 Jan 10, 2024
@savente93 savente93 added the V1 label Jan 11, 2024
@savente93 savente93 modified the milestones: v1.0, 2024 - Q1 Jan 11, 2024
@hboisgon hboisgon removed the Blocked An issue that cannot be progressed right now label Jan 11, 2024
@hboisgon
Copy link
Contributor

After filling the table and discussions: we will use more explicit names in hydromt (upstream_area instead of uparea) and if it is a statistics, include it in the name (eg area_min, area_avg). For units, we may want to investigate if we can use a python library to convert units based on the attribute of the input data.

@hboisgon hboisgon linked a pull request Jan 16, 2024 that will close this issue
9 tasks
@savente93 savente93 linked a pull request Feb 20, 2024 that will close this issue
9 tasks
@savente93 savente93 modified the milestones: 2024 - Q1, 2024 - Q2 Apr 8, 2024
@savente93 savente93 added the Blocked An issue that cannot be progressed right now label Apr 8, 2024
@savente93
Copy link
Contributor

Blocked until data catalog can be updated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Blocked An issue that cannot be progressed right now Documentation Improvements or additions to documentation V1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants