[X] I have checked that the issue still exists on the latest versions of the docs on mainhere
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?
HydroMT-Wflow version checks
main
hereKind 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
To
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?