feat(geopandas support): return GeoDataFrame if geopandas is installed #143
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thodson-usgs
requested changes
Jul 16, 2024
Collaborator
thodson-usgs
left a comment
thodson-usgs
left a comment
There was a problem hiding this comment.
Very nice. Even better if you added a unit test, but I'll approve it either way.
Otherwise, I had one comment.
| if service == 'peaks': | ||
| df = preformat_peaks_response(df) | ||
|
|
||
| if gpd is not None: |
Collaborator
There was a problem hiding this comment.
Does this remove the original lat/lon column?
If so (and perhaps either way), we should make this conversion optional, so that we don't break existing codes.
Contributor
Author
There was a problem hiding this comment.
This maintains the original lat/long columns. This PR just builds a geometry field from that data and creates a geodataframe. I can add a unit test that checks the return type
Contributor
Author
There was a problem hiding this comment.
Updated tests for geopandas support
aaraney
added a commit
to aaraney/dataretrieval-python
that referenced
this pull request
Oct 25, 2024
The nwis site service (and the USGS more broadly) uses the NAD83 crs. 64a575d introduced a bug that hard coded the nwis module's crs to EPSG:4236 -- Hu Tzu Shan 1950 (https://epsg.io/4236). I guarantee 64a575d meant to hard code _EPSG:4326_ -- WGS84. It appears it was fat fingered and missed in DOI-USGS#143's PR review (it happens to the best of us:)). In either case, EPSG:4326 is still _technically_ the wrong crs. For example: https://waterservices.usgs.gov/nwis/site?sites=01013500&siteOutput=Expanded&format=rdb returns ``` USGS 01013500 ... NAD83 ``` for the field `coord_datum_cd -- Latitude-longitude datum`. So EPSG:4269 -- NAD83 is the correct crs. There is room for discussion if NAD83 vs WGS 84 really matters in the conterminous US however for Alaska errors in both the x and y direction can be upwards of 1 meter in either direction. BREAKING CHANGE: v1.0.10 is the only affected version. The GeoDataFrames returned from the following functions now correctly have a crs of EPSG:4269. dataretrieval.nwis.get_qwdata dataretrieval.nwis.get_discharge_measurements dataretrieval.nwis.get_discharge_peaks dataretrieval.nwis.get_gwlevels dataretrieval.nwis.get_stats dataretrieval.nwis.get_info dataretrieval.nwis.get_pmcodes dataretrieval.nwis.get_water_use dataretrieval.nwis.get_ratings dataretrieval.nwis.what_sites dataretrieval.nwis.get_dv dataretrieval.nwis.get_iv
thodson-usgs
pushed a commit
that referenced
this pull request
Oct 25, 2024
The nwis site service (and the USGS more broadly) uses the NAD83 crs. 64a575d introduced a bug that hard coded the nwis module's crs to EPSG:4236 -- Hu Tzu Shan 1950 (https://epsg.io/4236). I guarantee 64a575d meant to hard code _EPSG:4326_ -- WGS84. It appears it was fat fingered and missed in #143's PR review (it happens to the best of us:)). In either case, EPSG:4326 is still _technically_ the wrong crs. For example: https://waterservices.usgs.gov/nwis/site?sites=01013500&siteOutput=Expanded&format=rdb returns ``` USGS 01013500 ... NAD83 ``` for the field `coord_datum_cd -- Latitude-longitude datum`. So EPSG:4269 -- NAD83 is the correct crs. There is room for discussion if NAD83 vs WGS 84 really matters in the conterminous US however for Alaska errors in both the x and y direction can be upwards of 1 meter in either direction. BREAKING CHANGE: v1.0.10 is the only affected version. The GeoDataFrames returned from the following functions now correctly have a crs of EPSG:4269. dataretrieval.nwis.get_qwdata dataretrieval.nwis.get_discharge_measurements dataretrieval.nwis.get_discharge_peaks dataretrieval.nwis.get_gwlevels dataretrieval.nwis.get_stats dataretrieval.nwis.get_info dataretrieval.nwis.get_pmcodes dataretrieval.nwis.get_water_use dataretrieval.nwis.get_ratings dataretrieval.nwis.what_sites dataretrieval.nwis.get_dv dataretrieval.nwis.get_iv
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.