eeweather
eeweather copied to clipboard
Feature/international
Your checklist for this pull request
Please review the guidelines for contributing to this repository.
- [X] Make sure you are requesting to pull a feature/bugfix branch (right side). Don't request your master!
- [X] Make sure tests pass and coverage has not fallen
docker-compose run --rm test
. - [X] 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.
- [X] Make sure code style follows PEP 008 using
docker-compose run --rm blacken
. - [X] 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. - [X] 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 tosetup.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.
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.