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 station data using get_data() function #488

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

nicolejkeeney
Copy link
Collaborator

@nicolejkeeney nicolejkeeney commented Jan 18, 2025

Summary of changes and related issue

Added the ability to retrieve station data using get_data() function. Also added the ability to see weather station options using get_subsetting_options().

Relevant motivation and context

These functions were unfinished without station data. Plus, Victoria needs this functionality for some code she’s writing for an IOU.

How to test

Run the notebook climakitae_direct_data_download.ipynb in the branch get-station-data in cae-notebooks. At the bottom of that notebook, there’s some code related to how to use the new functionality from this branch. Try retrieving some different stations, resolutions, etc. Make sure the error messages make sense when you put a bad input, and that the data that is retrieved matches what you input in the function arguments.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • None of the above

To-Do

  • Unit tests
    • Existing unit tests are passing
    • If relevant, new unit tests are written (required 80% unit test coverage)
  • Documentation
  • Naming conventions followed
    • Helper functions hidden with _ before the name
  • Any notebooks known to utilize the affected functions are still working
  • Black formatting has been utilized
  • Tagged/notified 2 reviewers for this PR

@nicolejkeeney nicolejkeeney changed the title Get station data using ge Get station data using get_data() function Jan 18, 2025
@nicolejkeeney nicolejkeeney marked this pull request as ready for review January 20, 2025 21:57
@nicolejkeeney nicolejkeeney requested a review from vicford January 20, 2025 22:02
Copy link
Contributor

@vicford vicford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More a comment here:

My one big thought here is that for data_type the response is "Stations", while for get_subsetting_options the area_subset response is "Weather stations". Is there any reason we can't make those both "Stations"?

Otherwise, no issues retrieving, got some nice errors with bad intentional typos, especially with more than 1 station input providing "did you mean this" for both!

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.

2 participants