Data source type requirement in setup_ methods is not clear

[hboisgon]

HydroMT-Wflow version checks

• I have checked that the issue still exists on the latest versions of the docs on main here

Kind of issue

Docs are unclear

Location of the documentation

Each of the individual setup_ methods in the wflow.py script (API documentation)

Documentation problem

In the setup_ methods it is often unclear if the expected input data type is rasterdataset, geodataset, dataframe or geodataframe for example. I think this should be made clear in the documentation so that users know which type of data to prepare for model building.

Suggested fix for documentation

Example for setup_rivers:

From

        hydrography_fn : str, Path
            Name of data source for hydrography data.
            Must be same as setup_basemaps for consistent results.


            * Required variables: [flwdir, uparea, elevtn]
            * Optional variables: [rivwth, qbankfull]
        river_geom_fn : str, Path, optional
            Name of data source for river data.


            * Required variables: [rivwth, qbankfull]

To

        hydrography_fn : str, Path
            Name of RasterDataset source for hydrography data.
            Must be same as setup_basemaps for consistent results.


            * Required variables: [flwdir, uparea, elevtn]
            * Optional variables: [rivwth, qbankfull]
        river_geom_fn : str, Path, optional
            Name of GeoDataFrame source for river data.


            * Required variables: [rivwth, qbankfull]

Note: maybe a good moment to also update the docs that hydrography_fn can be data source in data catalog, xarray.Dataset or direct path to data?

[hboisgon]

Kind of related: some variables or dimensions names are missing from the docs. Known ones:

• cyclic time dimension (values 1 to 12) for LAI in setup_laimaps
• cyclic time dimension (values 1 to 12) for precip_clim_fn in setup_precip_forcing
• elevtn [m] required varibales for dem_forcing_fn in setup_temp_pet_forcing
• qbankfull unit [m3/s] is not documented in hydromt core (yet) for setup_rivers
• basin_index_fn ? + it is optional and not required anymore.

[hboisgon]

This issue is partly related to #157