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

[couasnonanais]

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]

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]

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

[savente93]

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.

[hboisgon]

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.

[savente93]

Blocked until data catalog can be updated