fatiando / boule

Reference ellipsoids for geodesy and geophysics
https://www.fatiando.org/boule
BSD 3-Clause "New" or "Revised" License
38 stars 17 forks source link

Deprecation: Coordinate conversion methods moved to pymap3d #122

Closed leouieda closed 2 years ago

leouieda commented 2 years ago

Boule implements conversion from geodetic to geocentric spherical coordinates. However, pymap3d already implements many of these conversions and with #121 our Ellipsoid class will be fully compatible with their functions.

I opened geospace-code/pymap3d#54 to ask if they'd want to have our functions and we can use pymap3d in our code instead. They are an extremely light dependency so it would be straight forward to add them as a dependency if we need coordinate conversions internally.

leouieda commented 2 years ago

Update: Submitted the implementation in the Ellipsoid methods to the new pymap3d.geodetic2spherical and pymap3d.spherical2geodetic functions in https://github.com/geospace-code/pymap3d/issues/55. The PR has been merged and the functions are already available in pymap3d v2.9.0.

So we should add a FutureWarning and deprecation notice on the docstrings and examples saying that these methods will be removed in v0.5.0 and people should use pymap3d >= 2.9.0 instead.