Resolve Nwm client IndexError: invalid index to scalar variable. (#180)

aaraney commented 2 years ago

See #180 for bug report. This PR lays the groundwork for two new releases of the hydrotools.nwm_client. The first release, 5.0.1-post1, pins h5netcdf<=0.13.0. This was done to support users who would like to use the software but are dependent on a h5netcdf<=0.13.0. The second release is 5.0.2, this pins h5netcdf>=0.14.0. 5.0.2 also includes a patch that fixes the IndexError propagating from h5netcdf==0.14.0.

fixes #180.

Guidance

if your application requires h5netcdf<=0.13.0, use hydrotools.nwm_client==5.0.1-post1
otherwise, use hydrotools.nwm_client>=5.0.2

Changes

Resolves IndexError: invalid index to scalar variable. present in hydrotools.nwm_client<=5.0.1

Checklist

[x] PR has an informative and human-readable title
[x] PR is well outlined and documented. See #12 for an example
[x] Changes are limited to a single goal (no scope creep)
[x] Code can be automatically merged (no conflicts)
[x] Code follows project standards (see CONTRIBUTING.md)
[ ] Passes all existing automated tests
[x] Any change in functionality is tested
[x] New functions are documented (with a description, list of inputs, and expected output) using numpy docstring formatting
[x] Placeholder code is flagged / future todos are captured in comments
[x] Reviewers requested with the Reviewers tool :arrow_right:

jarq6c commented 2 years ago

@aaraney How do we merge this? Is it possible to merge just the first two commits, make a release, then go back and merge the last 3 commits, and then make another new release?

jarq6c commented 2 years ago

I think this has to be two separate PRs. One that pins the old to h5netcdf<=0.13.0 and another that pins to h5netcdf>=0.14.0.

aaraney commented 2 years ago

@jarq6c, sorry im just now getting back to this. Its been one of those weeks.

@aaraney How do we merge this? Is it possible to merge just the first two commits, make a release, then go back and merge the last 3 commits, and then make another new release?

I assume that you mean releases to Pypi? If so, I plan on checking out the commit that bumps to the certain version and building from that point in the history. If you were talking about a release on GitHub / git, we can just tag a certain commit with version information and release note information. Does that answer your questions? If not, what am I missing?

hellkite500 commented 2 years ago

we can just tag a certain commit with version information and release note information

Merge the PR, make the tags based on the commments on this PR, and point the Pypi releases to those tags.

jarq6c commented 2 years ago

Thanks for the clarification!

jarq6c commented 2 years ago

Tag relevant commits without a release.

jarq6c commented 2 years ago

Tag is here: https://github.com/NOAA-OWP/hydrotools/releases/tag/nwm-client-5.0.1.post1 Associated release is here: https://pypi.org/project/hydrotools.nwm-client/5.0.1.post1/

Newest release to-date is here: https://pypi.org/project/hydrotools.nwm-client/5.0.3/

aaraney commented 2 years ago

Thanks for getting this merged in, @jarq6c!

NOAA-OWP / hydrotools