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

Feature/international #79

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

jfenna
Copy link

@jfenna jfenna commented Feb 13, 2023

Your checklist for this pull request

Please review the guidelines for contributing to this repository.

  • Make sure you are requesting to pull a feature/bugfix branch (right side). Don't request your master!
  • Make sure tests pass and coverage has not fallen docker-compose run --rm test.
  • Update the CHANGELOG.md to describe your changes in a bulleted list under the "Development" section at the top of the changelog. If this section does not exist, create it.
  • Make sure code style follows PEP 008 using docker-compose run --rm blacken.
  • Make sure that new functions and classes have inline docstrings and are
    included in docs/api.rst for the sphinx build. Please use numpy-style docstrings.
    Sphinx docs can be built with the following command: docker-compose run --rm --entrypoint="make -C docs html" shell. Please note and fix any warnings.
  • Make sure that all git commits are have the "Signed-off-by" message for
    the Developer Certificate of Origin. When you're making a commit, just add
    the -s/--signoff flag (e.g., git commit -s).

Description

EEWeather international is an international extension to the EEMeter international package of amendments submitted via pull request on 13 February 2023.

EEWeather international comprises:

  • Addition of a new international.py module, allowing for weather calling outside of the United States via the ECMWF Climate Data Store API; amendments to setup.py and __init__/py accordingly.
  • Addition of eeweather-intl tutorial.ipynb notebook.
  • Addition of tests.
  • Addition of samples folder with weather samples for testing and tutorial.

A detailed walkthrough of amendments can be found in the eeweather-intl tutorial.ipynb notebook.

James Fenna added 7 commits February 13, 2023 11:59
Signed-off-by: James Fenna <james@carbon.coop>
Signed-off-by: James Fenna <james@carbon.coop>
Signed-off-by: James Fenna <james@carbon.coop>
Signed-off-by: James Fenna <james@carbon.coop>
Signed-off-by: James Fenna <james@carbon.coop>
Signed-off-by: James Fenna <james@carbon.coop>
Signed-off-by: James Fenna <james@carbon.coop>
@philngo-recurve
Copy link
Contributor

Thank you for your pull request Some big additions in here. As discussed, we have some requested changes:

Dependencies

The additional dependencies required for using CDS data should be added as an extras_require since core functionality with NOAA data does not need them.

Geocoding is out of scope for the library and can be removed.

Extra Data Files

The CSV files in samples/intl_samples seem to be used only in the tutorial notebook and can be removed from the repo or consolidated into a smaller set.

Unit Tests

All existing unit tests passed. However, the new international tests fail due to relative path issues and a requirement for CDS credentials

Please slim down the number of files used in testing the new functionality from 100 to the bare minimum required to maintain the current level of tested code coverage.

docker-compose run test should run the full test suite without any steps required after commit ffd9dba is merged.

test_get_weather_intl should either use a mocked version of the API call or just be omitted.

James Fenna added 5 commits March 17, 2023 14:35
Signed-off-by: James Fenna <james@carbon.coop>
Signed-off-by: James Fenna <james@carbon.coop>
Signed-off-by: James Fenna <james@carbon.coop>
Signed-off-by: James Fenna <james@carbon.coop>
Signed-off-by: James Fenna <james@carbon.coop>
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