Add functions to convert hydrolib-core objects to (geo)pandas and others

[veenstrajelmer]

Is your feature request related to a problem? Please describe. Several packages and users are converting hydrolib-core objects to (geo)pandas and other classes, related issues:

• https://github.com/Deltares/HYDROLIB-core/issues/307
• https://github.com/Deltares/HYDROLIB-core/issues/375

Describe the solution you'd like Put the converter functions from dfm_tools, dfm_tools and hydromt_delft3dfm into hydrolib core.

The idea is to set the necessary libraries as optional dependencies, so hydrolib-core can still be installed with the bare minimum: https://github.com/Deltares/HYDROLIB-core/issues/552

First rename in dfm_tools (JV):

• https://github.com/Deltares/dfm_tools/issues/527

[xldeltares]

TODOs for hydromt-delft3dfm:

• [ ] switch 2d_boundary to Dataset, with quantity(e.g. "waterlevelbnd") as a variable.
• [ ] rename dimension index to locations or location - locations being the first support point on the pli line. The choice is because 1) consistent with 2D3D forcing types 2) avoid repeating forcing blocks 3) the kernel will interpolate along the line
• [ ] rename coordinates to location_x, location_y, and location_name
• [ ] use line geometry for pli file.

TODOS in general:

• [ ] communicate on the end product Dataset. Agree on any further discrepancies.
• [ ] prepare the writer functions that needs to be in hydrolib-core.
• [ ] schedule a working session together to see if the functions can be combined.
• [ ] discuss with hydrolib-core team how to best integrate with the current code.
• [ ] when kernel can handle 2d boundary as netcdf and make adjustment to the Dataset if needed
• [ ] use this (2d boundary) as an example to roll out for other components, e.g. geoms like crossection, fixed weirs (pliz file)