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

get_geodataframe and clipping by geom according to docs #932

Open
1 task done
shartgring opened this issue May 22, 2024 · 0 comments
Open
1 task done

get_geodataframe and clipping by geom according to docs #932

shartgring opened this issue May 22, 2024 · 0 comments
Labels
Documentation Improvements or additions to documentation Needs refinement issue still needs refinement

Comments

@shartgring
Copy link
Contributor

HydroMT 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

https://deltares.github.io/hydromt/latest/_generated/hydromt.data_catalog.DataCatalog.get_geodataframe.html

Documentation problem

According to the docs, the option is provided to clip the data:

"To clip the data to the area of interest, provide a bbox or geom, with optional additional buffer and align arguments. To return only the dataframe columns of interest provide the variables argument."

Does it really clip the data? After following the code, I end up in open_vector() in hydromt.io where the geom is used for the intersection of the data and the area of interest. That is not the same as clipping. Or am I missing something? I am not entirely sure and therefore asking ;)

Suggested fix for documentation

In the case that the data is indeed not clipped: add that the data is not really clipped but that the intersection is used to get the geodataframe

@shartgring shartgring added Documentation Improvements or additions to documentation Needs refinement issue still needs refinement labels May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Needs refinement issue still needs refinement
Projects
None yet
Development

No branches or pull requests

1 participant