v0.15.0

Release Notes

From release 0.15 onward, all minor versions of HyRiver packages will be pinned. This ensures that previous minor versions of HyRiver packages cannot be installed with later minor releases. For example, if you have py3dep==0.14.x installed, you cannot install pydaymet==0.15.x. This is to ensure that the API is consistent across all minor versions.

New Features

• In static_3dep_dem use rioxarray directly instead of rasterio since it can handle VRT files.
• Improve performance and accuracy of add_elevation by using the dynamic 3DEP service and setting the resolution based on the input xarray.DataArray or xarray.Dataset.
• Improve the performance of elevation_profile by using the static 3DEP service when the input resolution is 10 m (which is the default for this function).
• For now, retain compatibility with shapely<2 while supporting shapley>=2.

Bug Fixes

• In add_elevation, ensure that the resolution is in meters by reprojecting the input dataset to 5070 before extracting resolution and bound attributes.

v0.14.0

Release Notes

New Features

• Add a new function called add_elevation for adding elevation data as a new variable to an input xarray.DataArray or xarray.Dataset.
• The elevation_bycoords function now accepts a single coordinate and returns a float in addition to a list of coordinates that returned a list of elevations.
• Modify the elevation_bycoords function to use the new elevation point query service (EPQS) web service. This only affects the source="tnm" option.

Breaking Changes

• Bump the minimum required version of shapely to 2.0, and use its new API.

Internal Changes

• Sync all minor versions of HyRiver packages to 0.14.0.

v0.13.12

Release Notes

New Features

• Use pyflwdir package for depression filling operation instead of richdem since it appears to be unmaintained. Note that pyflwdir is an optional dependency. Also, pyflwdir depends on numba which is not available for Python 3.11 yet. You can follow the progress of numba's support for Python 3.11 here.
• Add a new function called get_dem for obtaining DEM that is a wrapper of static_3dep_dem and get_map functions. Since static_3dep_dem is faster, if the requested resolution is 10 m, 30 m, or 60 m, static_3dep_dem will be used. Otherwise, get_map will be used.

Internal Changes

• Significantly improve the performance of elevation_bycoords when tep is used as the source by using the static DEM data instead of the dynamic DEM.
• Fully migrate setup.cfg and setup.py to pyproject.toml.
• Convert relative imports to absolute with absolufy-imports.
• Sync all patch versions of HyRiver packages to x.x.12.

v0.13.11

Release Notes

New Features

• Use pyflwdir package for depression filling operation instead of richdem since it appears to be unmaintained. Note that pyflwdir is an optional dependency. Also, pyflwdir depends on numba which is not available for Python 3.11 yet. You can follow the progress of numba's support for Python 3.11 here.
• Add a new function called get_dem for obtaining DEM that is a wrapper of static_3dep_dem and get_map functions. Since static_3dep_dem is faster, if the requested resolution is 10 m, 30 m, or 60 m, static_3dep_dem will be used. Otherwise, get_map will be used.

Internal Changes

• Significantly improve the performance of elevation_bycoords when tep is used as the source by using the static DEM data instead of the dynamic DEM.
• Fully migrate setup.cfg and setup.py to pyproject.toml.
• Convert relative imports to absolute with absolufy-imports.

v0.13.10

Release Notes

New Features

• Refactor the show_versions function to improve performance and print the output in a nicer table-like format.

Bug Fixes

• Fix a compatibility issue with the new scipy version in elevation_profile where led to failure of interpolation.

v0.13.9

Release Notes

Bug Fixes

• Add the missing annotation import to the [cache_keys]{.title-ref} to ensure Python 3.8 and 3.9 work with Python 3.10 style type hinting.

v0.13.8

Release Notes

New Features

• Add a new function called static_3dep_dem for getting only DEM data at 10 m, 30, or 60 m resolution. This is useful for cases where only DEM data (i.e., not slope, aspect, or other terrain attributes that the Dynamic 3DEP service provides) is needed. This function is faster than get_map but is less flexible.

Internal Changes

• Modify the codebase based on Refurb suggestions.

v0.13.7

Release Notes

Internal Changes

• Use pyupgrade package to update the type hinting annotations to Python 3.10 style.
• Bump the minimum required version of HyRiver dependencies to the latest versions.

v0.13.6

Release Notes

Internal Changes

• Add the missing PyPi classifiers for the supported Python versions.

v0.13.5

Release Notes

Breaking Changes

• Append "Error" to all exception classes for conforming to PEP-8 naming conventions.

Internal Changes

• Increase the pixel limit for 3DEP's WMS from 8M to 10M to reduce number of service calls and improve performance.
• Bump the minimum versions of pygeoogc and pygeoutils to 0.13.5 and that of async-retriever to 0.3.5.