refactor(crs): provide support without pyproj, other deprecations #1850
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #1850 +/- ##
========================================
Coverage 72.1% 72.2%
========================================
Files 255 257 +2
Lines 56108 56397 +289
========================================
+ Hits 40499 40737 +238
- Misses 15609 15660 +51
|
|
@mwtoews 3.4.0 release is underway in support of mf6.4.2. The mf6 CI failure was caused by a file missing from the initial mf6.4.2 distribution, since fixed. The docs failure looks like a GitLab outage |
|
I thought this one was cutting a bit short-of-time, so it can wait for the next one. I can adjust these notices to: (assuming 3.5 is the next development version). I'll also modify messages from #1737 to be "removed for FloPy 3.5" too, as these keyword options are related, and will make for easier effort while eventually removing these options. |
|
@aleaf could you take a look at this PR? |
There was a problem hiding this comment.
Hi @mwtoews, sorry for the tardiness in getting to this. This looks good, thanks for restoring this functionality and for all of the code cleanup as well. Just one practical question- how do we ensure follow-through on all of the deprecations during the next minor release? I could see them being easy to miss. How do other projects handle this? Do we need to add searching for deprecations or something similar to our release checklist? Thanks.
| @@ -72,8 +94,6 @@ class Grid: | |||
| bottom elevations of all cells | |||
| idomain : int or ndarray | |||
| ibound/idomain value for each cell | |||
| crs : pyproj.CRS | |||
There was a problem hiding this comment.
why are we removing crs from the attributes documentation?
There was a problem hiding this comment.
It was moved further down to the property, which would render here (currently blank). With Sphinx it is cross-referencable using :py:attr:`crs. I might get around to moving the other property docs later, since it's easier to see and xref property docs beside the relevant code.
There was a problem hiding this comment.
Cool, good to know- I figured that was probably a better way to do it.
|
The last task that I'll get to is to increment the deprecations to 3.6. Update: this is now done. As for how to follow-up acting on them, I'm not aware of any automated process. It could be done using searching with (e.g.) |
This PR is is a continuation of #1737 which has a few broad aims:
crsparameter, which can take an EPSG integer, a PROJ string, or a CRS instance from pyproj. This single parameter replaces (and deprecates)epsg,proj4andproj4_strparameters, where present.prjfileparameter as a path to a.prjfile that describes a coordinate reference system, which replaces (and deprecates)prj, where present.This PR embeds these changes further within the code.
However, a vital change in this PR is to provide some support without pyproj installed. For instance, a modelgrid can be created using (e.g.)
crs="EPSG:26915"orcrs=26915, and the resulting object will always have a.epsgproperty with an integer code. This was the case before #1737, but was broken.Another important remark for flopy without pyproj, it is recommended to use (e.g.)
crs=26915as a parameter, but the.crsattribute is always None, since this this only returns a pyproj CRS instance.If this is too late to make it into flopy 3.4.0, the deprecation notices will be adjusted.