OWPHydroTools Release v2.4.0

Content

hydrotools-2.4.0
_restclient-3.1.1
nwis_client-3.4.1
nwm_client-8.0.0
events-1.1.7
metrics-1.3.5
svi_client-0.0.3

What's Changed

• Add future warning to nwm_client_new about package name change. by @jarq6c in #267
• Swap nwm-client by @jarq6c in #268
• update package name for docs workflow by @jarq6c in #269
• Update nwm docs by @jarq6c in #270

Full Changelog: v2.3.0...v2.4.0

OWPHydroTools Release v2.3.0

Content

hydrotools-2.3.0
_restclient-3.1.1
nwis_client-3.4.1
caches-0.1.5
nwm_client-5.1.5
events-1.1.7
nwm_client_new-7.4.4
metrics-1.3.5
svi_client-0.0.3

What's Changed

• Add Social Vulnerability Index (SVI) subpackage by @aaraney in #169
• Add COE, COP, and volumetric efficiency to metrics by @jarq6c in #195
• Add minimal unit handling to nwm_client by @jarq6c in #196
• Add SVI to readme by @aaraney in #199
• Update contribution.md by @aaraney in #201
• Pin importlib-metadata version in nwm_client_new by @aaraney in #221
• Optionally include additional metadata with nwis_client get requests by @jarq6c in #214
• Add pytest-aiohttp development dep to svi_client by @aaraney in #218
• Resolve nwis service raising pandas FutureWarning by @aaraney in #210
• Echo dependency versions in runners by @aaraney in #220
• Add guidance for installing hydrotools.caches on mac silicon by @aaraney in #222
• Narrow subpackage workflows in scope by @jarq6c in #225
• Update NWM Client New interfaces and bring up to feature parity with old client [Updated] by @jarq6c in #227
• Update nwm client new docs by @jarq6c in #230
• Add __bool__ to ParquetStore by @jarq6c in #232
• Add manual trigger options to individual tests. by @jarq6c in #233
• New Workflow Manual Trigger Incorrectly Indented by @jarq6c in #234
• Add interface to nwm_client_new for Azure Blob Storage by @jarq6c in #236
• Bump _restclient's aiohttp and aiohttp_client_cache version deps by @aaraney in #237
• Refactor RestClient to avoid creating circular references by @aaraney in #239
• Bring svi_client field name maps into compliance with pydanic>2 by @aaraney in #241
• Add ability to run slow tests gh action manually by @aaraney in #243
• docs: fix agu presentation link by @aaraney in #245
• Update events for pandas v3.0 compatibility by @jarq6c in #247
• Update nwm_client_new routelink source for NWM v3.0 expanded domain by @jarq6c in #249
• Patch nwm_client_new for Python 3.12 by @jarq6c in #251
• Update NWMFileClient.py concat method. by @jarq6c in #252
• update default units handler to use explicit cache folder by @jarq6c in #254
• Add nwis_client iv context handler by @JoshCu in #257
• Bump nwis_client version by @aaraney in #258
• Update hydrotools.metrics to newer Python versions by @jarq6c in #261
• Migrate setup.cfg to pyproject.toml by @aaraney in #263
• ci: run slow unit tests on 3.11 & 3.12 by @aaraney in #264
• Nwm client transition by @jarq6c in #265
• Update HT super package dependencies by @jarq6c in #266

New Contributors

• @JoshCu made their first contribution in #257

Full Changelog: v2.2.3...v2.3.0

OWPHydroTools Release v2.2.3

Content

hydrotools-2.2.3
_restclient-3.0.5
nwis_client-3.2.1
caches-0.1.3
nwm_client-5.0.3
events-1.1.5
metrics-1.2.3

What's Changed

• Add Kling-Gupta Efficiency by @jarq6c in #172
• Fix 160. **params arg in IVDataService.get now raises warning when case insensitively matches other parameters by @aaraney in #174
• Add cache_filename parameter to the NWIS Client constructor by @aaraney in #176
• Add nwm_client documentation and minor subpackage level import changes by @aaraney in #179
• Resolve Nwm client IndexError: invalid index to scalar variable. (#180) by @aaraney in #182
• Add check for complete categories when constructing contingency tables by @jarq6c in #184
• Add nwis_client CLI by @jarq6c in #185
• Patch update to nwm-client HTTP interface by @jarq6c in #186
• Suppress NWIS Client value_time warning by @jarq6c in #187
• Improvements to validation checks by @groutr in #189
• bump metrics version to 1.2.2 by @jarq6c in #190
• Make map conversions more efficient alternative by @jarq6c in #191
• HydroTools Superpackage Release 2.2.3 by @jarq6c in #194

New Contributors

• @groutr made their first contribution in #189

Full Changelog: v2.2.2...v2.2.3

OWPHydroTools Release v2.2.2

Content

hydrotools-2.2.2
_restclient-3.0.5
nwis_client-3.0.6
caches-0.1.3
nwm_client-5.0.1
events-1.1.5
metrics-1.1.3

Notes

gcp_client is still available, but deprecated. nwm_client_new is still in pre-release development. The hydrotools superpackage now pulls in google-cloud-storage dependencies by default.

What's Changed

• Warn for Null values in series when calling event detection by @jarq6c in #124
• Update documentation by @jarq6c in #125
• update name version and front page by @jarq6c in #126
• Update package level installation makefile by @aaraney in #128
• Fix #99: "RuntimeError: This event loop is already running" in colab and notebook. Re-PR of #100 by @aaraney in #130
• fix nwis_client bug causing KeyError when station does not return data -- Updated by @jarq6c in #135
• fix nwis_client bug causing KeyError when station does not return data by @aaraney in #134
• nwis_client now requires _restclient >= 3.0.4 by @aaraney in #140
• Redesign NWM Client Subpackage by @jarq6c in #138
• Move package/subpackage version inside package source by @aaraney in #142
• Move nwm_client_new version inside package source by @aaraney in #149
• fix 153; _restclient pins aiohttp version to <=3.7.4.post0 by @aaraney in #154
• Switch NWM Crosswalk Source from CSV to URL by @jarq6c in #156
• NWM Client: Limit number of get calls for testing by @jarq6c in #158
• NWM Client New: Separate Large Modules by @jarq6c in #159
• Metrics: Default to numpy scalars for computation by @jarq6c in #163
• Advance Superpackage to 2.2.2 by @jarq6c in #165

Full Changelog: v2.1.2...v2.2.2

OWPHydroTools Release v2.1.2

Content

hydrotools-2.1.2
_restclient-3.0.3
nwis_client-3.0.4
caches-0.1.3
nwm_client-5.0.1
events-1.1.4
metrics-1.0.3

Details

Mostly minor documentation updates. Switched from gcp_client to nwm_client to move toward providing a unified interface for accessing NWM data. gcp_client is still available, but deprecated. nwm_client includes an http interface for retrieving data from generic web servers.

OWPHydroTools Release v2.1.1

Content

hydrotools-2.1.1
_restclient-3.0.2
nwis_client-3.0.3
caches-0.1.2
gcp_client-4.1.1
events-1.1.3
metrics-1.0.2

Details

Includes various bug fixes and improves documentation to reflect slightly new functionality from last release. Package structures have been refactored to adopt a "src" folder structure and use setup.cfg files. This makes for a slightly cleaner package base and unifies installation and development under pip.

This release includes the addition of the hydrotools super package. This allows installation of all packages using:

$ python3 -m pip install hydrotools

Minimum versions are set where applicable to guarantee cross-package compatibility.

Hydrotools Release v2.1.0

Additions

• IVDataService parameters: enable_cache and cache_expire_after allowing control over cache usage.
• Url keyword arguments quote_treatment, safe, and quote_overide_map added to support flexibility in quoted url representation. Urls are still comparable using the == operator however urls can differ in their quote_url representation.
• RestClient.mget now accepts a collection of query parameters and/or headers. It is not required to provide urls to mget if base url is set. Thus, a collection of query's can be passed in a collection and the will be built into requests as parameters of the base url.
• Url: Treat urls like to pathlib.Paths. Supports appending paths with / and appending url query parameters with +.
• ClientSession: Extension of aiohttp_client_cache that adds exponential backoff.
• Variadic: Join list or tuple of objects on some delimiter. Useful when query parameters utilize a non-key=value&key=value2 pattern.

Removals

• IVDataService parameters: process and retry removed.
• All code using multiprocessing removed
• IVDataService method following pattern get_raw_ and get_json removed
• U.S. State constants removed and no longer checked
• procs property removed

Changes

• IVDataService now uses aiohttp via _restclient to do asynchronous retrieval of data.
• documentation updated with examples
• IVDataService::get
  • now accepts multiple states, hucs, counties, bounding boxes
  • is now an instance method instead of a classmethod
• The default splitting factor for sites is now 20 instead of the previous 100.
• Update Url docstring to reflect new kwarg additions
• RestClient: a class which offers asynchronous performance via a convenient serial wrapper, sqlite database GET request caching, GET request backoff, batch GET requests, and flexible url argument encoding.
• RestClient parameters changed (breaking).

HydroTools Release v2.0.0-alpha.1

Last release before transition to asynchronous _restclient and nwis_client.

Subpackages

_restclient v2.1.0-alpha.0
caches v0.1.1
events 1.0.2
gcp_client 3.0.0
metrics 1.0.1
nwis_client 2.0.0-alpha.0

v2.0.0-alpha.0

Major change. Namespace moved from evaluatoin_tools to hydrotools. This included the repo itself. Please update your remote using git remote set-url origin [email protected]:NOAA-OWP/hydrotools.git.

Evaluation Tools Release v1.3.5

• Refinements to event detection noise handling
• Updates to package handling
• Incorporates additional metrics (MSE and NSE)
• Last release before namespace change to hydrotools