Pygeohydro

-------------------
This release provides access to three new datasets:

- USACE Hydrographic Surveys (eHydro) and
- USGS Short-Term Network (STN) Flood Event Data,
contributed by `Fernando Aristizabal <https://github.com/fernando-aristizabal>`__.
(:pull_hydro:`108`)
- NLCD 2021

New Features
~~~~~~~~~~~~
- Add support for getting topobathymetry data from USACE Hydrographic
Surveys (eHydro). The new class is called ``EHydro`` and gives users
the ability to subset the eHydro dataset by geometry, ID, or SQL queries.
- Add new ``stnfloodevents`` module with ``STNFloodEventData`` class for
retrieving flood event data from the
`USGS Short-Term Network (STN) <https://stn.wim.usgs.gov/STNWeb/#/>`__
RESTful Service. This Python API abstracts away RESTful principles and
produces analysis ready data in geo-referenced GeoDataFrames, DataFrames,
lists, or dictionaries as desired. The core class methods available are
``data_dictionary``, ``get_all_data``, and ``get_filtered_data``.
These class methods retrieve the data dictionaries by type, get all the
available data by type, and make filtered requests for data by type as well,
respectively. The four types of data include ``instruments``, ``peaks``,
``hwms``, and ``sites``.
Contributed by `Fernando Aristizabal <https://github.com/fernando-aristizabal>`__.
- Add a wrapper function for the ``STNFloodEventData`` class called
``stn_flood_event``.
- Add support for the new NLCD data (2021) for the three supported layers.

-------------------
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
~~~~~~~~~~~~
- Add a new option to ``NWIS.get_info``, called ``nhd_info``, for
retrieving NHDPlus related info on the sites. This will two new
service calls that might slow down the function, so it's disabled
by default.
- Update links in ``NID`` to the latest CSV and GPKG versions of
the NID dataset.
- Add two new properties to ``NID`` to access the entire NID dataset.
You can use ``NID.df`` to access the CSV version as a
``pandas.DataFrame`` and ``NID.gdf`` to access the GPKG version
as a ``geopandas.GeoDataFrame``. Installing ``pyogrio`` is highly
recommended for much faster reading of the GPKG version.
- Refactor ``NID.bygeom`` to use the new ``NID.gdf`` property for
spatial querying of the dataset. This change should make the query
much faster.
- For now, retain compatibility with ``shapely<2`` while supporting
``shapley>=2``.

-------------------

New Features
~~~~~~~~~~~~
- Add a new function, called ``nlcd_area_percent``, for computing the
percentages or natural, developed, and impervious areas within geometries
of a given ``GeoDataFrame``. This function uses imperviousness and land
use/land cover data from NLCD to compute the area percentages of the natural,
developed, and impervious areas. For more information please refer to the
function's documentation.
- Add a new column to the dataframe returned by ``NWIS.get_info``, called
``nhd_comid``, and rename ``drain_sqkm`` to ``nhd_areasqkm``. The new
drainage area is the best available estimates of stations' drainage area
that have been extracted from the NHDPlus. The new ``nhd_comid`` column
makes it easier to link stations to NHDPlus.
- In ``get_camels``, return ``qobs`` with negatives values set to ``NaN``.
Also, Add a new variable called ``Newman_2017`` to both datasets for
identifying the 531 stations that were used in
`Newman et al. (2017) <https://doi.org/10.1175/JHM-D-16-0284.1>`__.
- Add a new function, called ``streamflow_fillna``, for filling missing
streamflow values (``NAN``) with day-of-year average values.

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.
- Improve performance of all NLCD functions by merging two methods of
the ``NLCD`` and also reducing the memory footprint of the functions.

--------------------

New Features
~~~~~~~~~~~~
- Add initial support for `SensorThings API <https://labs.waterdata.usgs.gov/api-docs/about-sensorthings-api/index.html/>`__
Currently, the ``SensorThings`` class only supports ``Things`` endpoint.
Users need to provide a valid Odata filter. The class has a ``odata_helper``
function that can be used to generate and validate Odata filters.
Additionally, using ``sensor_info`` and ``sensor_property`` functions
users can request for information about sensors themselves or their properties.

Internal Changes
~~~~~~~~~~~~~~~~
- Simplify geometry validation by using ``pygeoutils.geo2polygon``
function in ``ssebopeta_bygeom``.
- 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.

--------------------

Breaking Changes
~~~~~~~~~~~~~~~~
- The NID service has changed some of its endpoints to use Federal ID
instead of Dam ID. This change affects the ``NID.inventory_byid``
function. This function now accepts Federal IDs instead of dam IDs.

New Features
~~~~~~~~~~~~
- Refactor the ``show_versions`` function to improve performance and
print the output in a nicer table-like format.

Internal Changes
~~~~~~~~~~~~~~~~
- Use the new ``pygeoogc.streaming_download`` function in ``huc_wb_full``
to improve performance and reduce code complexity.
- Skip 0.13.9 version so the minor version of all HyRiver packages become
the same.
- Modify the codebase based on the latest changes in ``geopandas`` related
to empty dataframes.
- Use ``pyright`` for static type checking instead of ``mypy`` and address
all typing issues that it raised.

-------------------

New Features
~~~~~~~~~~~~
- Add a function called ``huc_wb_full`` that returns the full watershed
boundary ``GeoDataFrame`` of a given HUC level. If only a subset of HUCs
is needed the ``pygeohydro.WBD`` class should be used. The full dataset
is downloaded from the National Maps'
`WBD staged products <https://prd-tnm.s3.amazonaws.com/index.html?prefix=StagedProducts/Hydrography/WBD/HU2/Shape/>`__.
- Add a new function called ``irrigation_withdrawals`` for retrieving estimated
monthly water use for irrigation by 12-digit hydrologic unit in the
CONUS for 2015 from `ScienceBase <https://doi.org/10.5066/P9FDLY8P>`__.
- Add a new property to ``NID``, called ``data_units`` for indicating the
units of NID dataset variables.
- The ``get_us_states`` now accepts ``conus`` as a ``subset_key`` which is
equivalent to ``contiguous``.

Internal Changes
~~~~~~~~~~~~~~~~
- Add ``get_us_states`` to ``__init__`` file, so it can be loaded directly,
e.g., ``gh.get_us_states("TX")``.
- Modify the codebase based on `Refurb <https://github.com/dosisod/refurb>`__
suggestions.
- Significant performance improvements in ``NWIS.get_streamflow`` especially
for large requests by refactoring the timezone handling.

Bug Fixes
~~~~~~~~~
- Fix the dam types and purposes mapping dictionaries in ``NID`` class.