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

Update the stations method to return all active stations #41

Merged
merged 6 commits into from
Aug 28, 2024

Conversation

CDJellen
Copy link
Owner

Summary of core changes:

This PR addresses issue #40 by changing the source of the stations data to the NDBC's full cataloge of active stations, rather than only reporting the set of stations directly owned and operated by the NDBC.

  • When returning stations from api.stations() the full collection of ~1380 stations is now available, along with their location and some limited metdata.
  • When calling api.nearest_station(...), all of these stations are now candidates, the same goes for api.radial_search(...)
  • There is a new endpoint, api.historical_stations() which returns the full collection of all logged deployments of stations and buoys by NDBC or partner organizations, structured such that each row captures one deployment period.

Future Improvements:

This change better aligns the API with the data offered by NDBC. #40 also makes an excellent suggestion for first-class netcdf support. This update is in progress, and will follow in a subsequent release.

@CDJellen CDJellen added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 28, 2024
@CDJellen CDJellen self-assigned this Aug 28, 2024
@CDJellen CDJellen merged commit e444675 into main Aug 28, 2024
4 checks passed
@CDJellen CDJellen deleted the user/cjellen/show-all-available-stations branch August 28, 2024 14:16
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant