NumPy 2.0 compatibility

[wpbonelli]

Opening this (somewhat belatedly) to track support for NumPy 2.0, due out soon. The maintainers recommend downstream projects make a compatible release before 2.0 drops. We have already made some progress updating API usages. The biggest consideration is our runtime dependencies on projects which depend on numpy (checks indicate whether the project has released 2.0 support)

• pandas (required) ✓
• matplotlib (required) ✓
• scipy (optional) ✓
• pyvista (optional) ✓
• rasterio (optional) ✓
• shapely (optional) ✓
• netcdf4 (optional) ✓

Core requirements (pandas and mpl) are already covered. If 2.0 is imminent before all our optional dependencies support it, we will need to decide whether to release immediately or wait, but it sounds like at least a month remaining, so with luck it won't come to that.

Tasks:

• pin numpy<2.0 until supported
  • refactor(dependencies): pin numpy<2 until other reqs support it #2092
• update deprecated/removed syntax
  • hotfix(numpy 2.0 deprecation) #2088
  • chore: switch to ruff, numpy compat fixes, ignore known test warnings #2124
• run ruff rule NPY201, all looks good
• accommodate dtype promotion changes — this may be an ongoing task, as these can easily go unnoticed where not captured by a regression/snapshot test
  • refactor(lgrutil): coerce numpy types to builtins for np2 compat #2158
• pass all tests with numpy>=2.0.0

[wpbonelli]

Per the latest announcement numpy 2.0 will come out in 3.5 weeks. Flopy 3.7 is planned tomorrow to coincide with MF6.5.0, but optional dependencies have not all released np2 support. I see two paths:

• Release numpy2 support with 3.7.0, and warn that optional dependencies are not guaranteed to be compatible yet. Installs will work fine for the core flopy package, but may break for the optional dependencies if the user has np2+, as will features using them (e.g. netcdf export).
• Keep numpy pinned <2 for 3.7.0, and plan to release numpy2 support with 3.7.1+ in the next few weeks, if/when netcdf4-python does. Installs will continue to work in the meantime, but we may end up here again if a netcdf release is not forthcoming, in which case I'm not sure anything further can be done to avoid potential breakage

[jdhughes-dev]

@wpbonelli I think we should pin to <2 for 3.7.0 and do another release later

[wpbonelli]

NumPy 2.0 came out today.

Netcdf4-python has made a numpy2-compatible release (1.7.0) but there are some issues with the package. Seems like they are working on a fix, after which I think we can proceed at any time.

Should we make a new release promptly? We have a number of bugfixes and a couple new features since 3.7.0. I guess np2 support could also be considered a feature, so by semver this would be 3.8.0. If others agree I can remove the pin and get the ball rolling when netcdf4 is ready.

[christianlangevin]

NumPy 2.0 came out today.

Netcdf4-python has made a numpy2-compatible release (1.7.0) but there are some issues with the package. Seems like they are working on a fix, after which I think we can proceed at any time.

Should we make a new release promptly? We have a number of bugfixes and a couple new features since 3.7.0. I guess np2 support could also be considered a feature, so by semver this would be 3.8.0. If others agree I can remove the pin and get the ball rolling when netcdf4 is ready.

I like the idea of making a new release that supports numpy 2.0. We will likely have others as this all settles in, but my opinion is to keep moving it forward.