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 overview notebook #58

Merged
merged 1 commit into from
Nov 24, 2024

Conversation

CDJellen
Copy link
Owner

Summary of core changes:

  • Structural changes to the overview notebook
  • Improved the content describing the API's get_modes method and it's returns
  • Streamlining of the sections covering the available_realtime and available_historical methods
  • Corrections to the get_data section in light of the use of a multi-index in response.

These changes are thanks to #57 which highlighted the shortcomings of the current overview notebook.

Future changes:

  • Improvements to the API which help answer the question "what data modes are available for a given station at a given time" without having to parse through NDBC URLs.
  • Updates to flags in the methods throughout the API.
  • Inclusion of station metadata in the xarray.Dataset object returned by the get_data method.

@CDJellen CDJellen merged commit bd76b90 into main Nov 24, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant