pyTMD 2.2.8__tar.gz → 2.2.9__tar.gz

{pytmd-2.2.8/pyTMD.egg-info → pytmd-2.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyTMD
-Version: 2.2.8
+Version: 2.2.9
 Summary: Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides
 Author: Tyler Sutterley
 Author-email: tsutterl@uw.edu
@@ -52,7 +52,8 @@ License-File: LICENSE
 Requires-Dist: lxml
 Requires-Dist: netCDF4
 Requires-Dist: numpy
-Requires-Dist: pyproj
+Requires-Dist: platformdirs
+Requires-Dist: pyproj>=2.5.0
 Requires-Dist: python-dateutil
 Requires-Dist: scipy>=1.10.1
 Requires-Dist: timescale>=0.0.8
@@ -71,25 +72,26 @@ Requires-Dist: cartopy; extra == "all"
 Requires-Dist: ipyleaflet; extra == "all"
 Requires-Dist: ipywidgets; extra == "all"
 Requires-Dist: jplephem; extra == "all"
+Requires-Dist: jupyterlab; extra == "all"
 Requires-Dist: matplotlib; extra == "all"
 Requires-Dist: notebook; extra == "all"
 Requires-Dist: pandas; extra == "all"
+Requires-Dist: xarray; extra == "all"
 Provides-Extra: aws
-Requires-Dist: xarray; extra == "aws"
 Requires-Dist: dask; extra == "aws"
-Requires-Dist: zarr>=3; extra == "aws"
-Requires-Dist: h5netcdf; extra == "aws"
 Requires-Dist: geopandas; extra == "aws"
-Requires-Dist: pyarrow; extra == "aws"
+Requires-Dist: h5netcdf; extra == "aws"
 Requires-Dist: obstore; extra == "aws"
+Requires-Dist: pyarrow; extra == "aws"
 Requires-Dist: s3fs; extra == "aws"
+Requires-Dist: zarr>=3; extra == "aws"
 Provides-Extra: dev
 Requires-Dist: flake8; extra == "dev"
+Requires-Dist: gh; extra == "dev"
+Requires-Dist: oct2py; extra == "dev"
 Requires-Dist: pytest>=4.6; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-xdist; extra == "dev"
-Requires-Dist: oct2py; extra == "dev"
-Requires-Dist: boto3; extra == "dev"
 Dynamic: license-file
 
 # pyTMD
@@ -166,6 +168,7 @@ This will automatically create the environment, install all dependencies, and la
 - [lxml: processing XML and HTML in Python](https://pypi.python.org/pypi/lxml)
 - [netCDF4: Python interface to the netCDF C library](https://unidata.github.io/netcdf4-python/)
 - [numpy: Scientific Computing Tools For Python](https://www.numpy.org)
+- [platformdirs: Python module for determining platform-specific directories](https://pypi.org/project/platformdirs/)
 - [pyproj: Python interface to PROJ library](https://pypi.org/project/pyproj/)
 - [scipy: Scientific Tools for Python](https://www.scipy.org/)
 - [timescale: Python tools for time and astronomical calculations](https://pypi.org/project/timescale/)
@@ -208,7 +211,7 @@ It should not be used for coastal navigation or any application that may risk li
 
 ## Contributing
 
-This project contains work and contributions from the [scientific community](./CONTRIBUTORS.rst).
+This project contains work and contributions from the [scientific community](./CONTRIBUTORS.md).
 If you would like to contribute to the project, please have a look at the [contribution guidelines](./doc/source/getting_started/Contributing.rst), [open issues](https://github.com/pyTMD/pyTMD/issues) and [discussions board](https://github.com/pyTMD/pyTMD/discussions).
 
 ## Credits

{pytmd-2.2.8 → pytmd-2.2.9}/README.md

@@ -72,6 +72,7 @@ This will automatically create the environment, install all dependencies, and la
 - [lxml: processing XML and HTML in Python](https://pypi.python.org/pypi/lxml)
 - [netCDF4: Python interface to the netCDF C library](https://unidata.github.io/netcdf4-python/)
 - [numpy: Scientific Computing Tools For Python](https://www.numpy.org)
+- [platformdirs: Python module for determining platform-specific directories](https://pypi.org/project/platformdirs/)
 - [pyproj: Python interface to PROJ library](https://pypi.org/project/pyproj/)
 - [scipy: Scientific Tools for Python](https://www.scipy.org/)
 - [timescale: Python tools for time and astronomical calculations](https://pypi.org/project/timescale/)
@@ -114,7 +115,7 @@ It should not be used for coastal navigation or any application that may risk li
 
 ## Contributing
 
-This project contains work and contributions from the [scientific community](./CONTRIBUTORS.rst).
+This project contains work and contributions from the [scientific community](./CONTRIBUTORS.md).
 If you would like to contribute to the project, please have a look at the [contribution guidelines](./doc/source/getting_started/Contributing.rst), [open issues](https://github.com/pyTMD/pyTMD/issues) and [discussions board](https://github.com/pyTMD/pyTMD/discussions).
 
 ## Credits

{pytmd-2.2.8 → pytmd-2.2.9}/pyTMD/__init__.py

@@ -22,19 +22,17 @@ import pyTMD.spatial
 import pyTMD.tools
 import pyTMD.utilities
 import pyTMD.version
+from pyTMD import datasets
 from pyTMD import io
 from pyTMD import solve
 from pyTMD.crs import crs
 
 # Deprecated functions
-from pyTMD.compute_tide_corrections import (
-    compute_corrections,
-    compute_tide_corrections,
-    compute_LPET_corrections,
-    compute_LPT_corrections,
-    compute_OPT_corrections,
-    compute_SET_corrections,
-)
+def compute_tide_corrections(*args, **kwargs):
+    """Wrapper function to compute tide corrections
+    Deprecated, use :func:`pyTMD.compute.tide_elevations` instead
+    """
+    return pyTMD.compute.tide_elevations(*args, **kwargs)
 
 # get version information
 __version__ = pyTMD.version.version

{pytmd-2.2.8 → pytmd-2.2.9}/pyTMD/arguments.py

@@ -40,6 +40,7 @@ REFERENCES:
 
 UPDATE HISTORY:
     Updated 09/2025: added spherical harmonic degree to tide potential tables
+        added IERS Conventions references for Love number calculations
     Updated 08/2025: add Cartwright and Tayler table with radiational tides
         make frequency function a wrapper around one that calculates using
             Doodson coefficients (Cartwright numbers)
@@ -1929,7 +1930,7 @@ def _complex_love_numbers(
     omega: np.ndarray
         angular frequency (radians per second)
     kwargs: dict
-        additional keyword arguments for love number calculation
+        additional keyword arguments for Love number calculation
 
     Returns
     -------
@@ -1940,20 +1941,24 @@ def _complex_love_numbers(
     l2: complex
         Degree-2 Love (Shida) number of horizontal displacement
     """
-    # (number of sidereal days per solar day)
+    # number of sidereal days per solar day
     sidereal_ratio = 1.002737909
-    # number of seconds in a sidereal day (approx 86164.1)
+    # number of seconds in a sidereal day (approximately 86164.1)
     sidereal_day = 86400.0/sidereal_ratio
     # frequency in cycles per sidereal day
     f = omega*sidereal_day/(2.0*np.pi)
     # Love numbers for different frequency bands
     if (omega == 0.0):
-        # use real-valued body tide love numbers for permanent tide
+        # use real-valued body tide Love numbers for the permanent tide
+        # to prevent singularities in frequency-dependent model
         h2, k2, l2 = _love_numbers(omega, **kwargs)
     elif (omega > 1e-4):
         # in-phase and out-of-phase components for the semi-diurnal band
-        h2 = 0.6078 - 0.0022j
+        # table 7.3a (IERS conventions 2010)
+        h2 = 0.6078 - 0.0025j
+        # table 6.5c (IERS conventions 2010)
         k2 = 0.30102 - 0.0013j
+        # table 7.3a (IERS conventions 2010)
         l2 = 0.0847 - 0.0007j
     elif (omega < 2e-5):
         # compute in-phase and out-of-phase components for the long period band
@@ -1963,9 +1968,12 @@ def _complex_love_numbers(
         fm = sidereal_day/200.0
         factor = np.tan(alpha*np.pi/2.0)**(-1)
         anelasticity_model = factor*(1.0 - (fm/f)**alpha) + 1j*(fm/f)**alpha
-        # model for the variation of love numbers across the zonal tide band
+        # model for the variation of Love numbers across the zonal tide band
+        # equation 7.4a (IERS conventions 2010)
         h2 = 0.5998 - 9.96e-4*anelasticity_model
+        # equation 6.12 (IERS conventions 2010)
         k2 = 0.29525 - 5.796e-4*anelasticity_model
+        # equation 7.4b (IERS conventions 2010)
         l2 = 0.0831 - 3.01e-4*anelasticity_model
     else:
         # in-phase and out-of-phase components for the diurnal band
@@ -1981,31 +1989,35 @@ def _complex_love_numbers(
         sigma[2] = 1.0023181 + 0.000025j
         # prograde free core nutation
         sigma[3] = 0.999026 + 0.000780j
-        # frequency dependence of Love number h2
+        # frequency dependence of Love number h2 (vertical)
+        # table 7.1 (IERS conventions 2010)
         H2 = np.zeros((4), dtype=np.complex128)
         H2[0] = 0.60671 - 0.242e-2j
         H2[1] = -0.15777e-2 - 0.7630e-4j
         H2[2] = 0.18053e-3 - 0.6292e-5j
         H2[3] = -0.18616e-5 + 0.1379e-6j
-        # frequency dependence of Love number k2
+        # frequency dependence of Love number k2 (potential)
+        # table 6.4 (IERS conventions 2010)
         K2 = np.zeros((4), dtype=np.complex128)
         K2[0] = 0.29954 - 0.1412e-2j
         K2[1] = -0.77896e-3 - 0.3711e-4j
         K2[2] = 0.90963e-4 - 0.2963e-5j
         K2[3] = -0.11416e-5 + 0.5325e-7j
-        # frequency dependence of Love number l2
+        # frequency dependence of Love number l2 (horizontal)
+        # table 7.1 (IERS conventions 2010)
         L2 = np.zeros((4), dtype=np.complex128)
         L2[0] = 0.84963e-1 - 0.7395e-3j
         L2[1] = -0.22107e-3 - 0.9646e-5j
         L2[2] = -0.54710e-5 - 0.2990e-6j
         L2[3] = -0.29904e-7 - 0.7717e-8j
-        # estimate the complex Love number fors diurnal tides
-        # equation 6.9 of IERS conventions 2010
+        # estimate the complex Love numbers for diurnal tides
+        # equation 6.9 (IERS conventions 2010)
         h2 = np.sum(H2/(f - sigma))
         k2 = np.sum(K2/(f - sigma))
         l2 = np.sum(L2/(f - sigma))
 
     # return the Love numbers as a complex number
+    # to include the in-phase and out-of-phase components
     return np.array([h2, k2, l2], dtype=np.complex128)
 
 # Doodson (1921) table with values missing from Cartwright tables

{pytmd-2.2.8 → pytmd-2.2.9}/pyTMD/astro.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 astro.py
-Written by Tyler Sutterley (09/2025)
+Written by Tyler Sutterley (10/2025)
 Astronomical and nutation routines
 
 PYTHON DEPENDENCIES:
@@ -18,6 +18,7 @@ REFERENCES:
     Oliver Montenbruck, Practical Ephemeris Calculations, 1989.
 
 UPDATE HISTORY:
+    Updated 10/2025: change default directory for JPL SSD kernels to cache
     Updated 09/2025: added function to compute the planetary mean longitudes
     Updated 08/2025: convert angles with numpy radians and degrees functions
         convert arcseconds to radians with asec2rad function in math.py
@@ -78,6 +79,7 @@ from pyTMD.math import (
 )
 from pyTMD.utilities import (
     get_data_path,
+    get_cache_path,
     import_dependency,
     from_jpl_ssd
 )
@@ -116,7 +118,7 @@ __all__ = [
 ]
 
 # default JPL Spacecraft and Planet ephemerides kernel
-_default_kernel = get_data_path(['data','de440s.bsp'])
+_default_kernel = get_cache_path('de440s.bsp')
 
 # number of days between the Julian day epoch and MJD
 _jd_mjd = 2400000.5
@@ -282,10 +284,10 @@ def planetary_longitudes(MJD: np.ndarray):
     mercury_longitude = np.array([252.250906, 149474.0722491, 3.035e-4, 1.8e-8])
     LMe = polynomial_sum(mercury_longitude, T)
     # mean longitudes of Venus
-    venus_longitude = np.array([181.9798001, 58519.2130302, 3.1014e-4, 1.5e-8])
+    venus_longitude = np.array([181.979801, 58519.2130302, 3.1014e-4, 1.5e-8])
     LVe = polynomial_sum(venus_longitude, T)
     # mean longitudes of Mars
-    mars_longitude = np.array([355.433, 19141.6964471, 3.1052e-4, 1.e-8])
+    mars_longitude = np.array([355.433, 19141.6964471, 3.1052e-4, 1.6e-8])
     LMa = polynomial_sum(mars_longitude, T)
     # mean longitudes of Jupiter
     jupiter_longitude = np.array([34.351519, 3036.3027748, 2.233e-4, 3.7e-8])

{pytmd-2.2.8 → pytmd-2.2.9}/pyTMD/compute.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 compute.py
-Written by Tyler Sutterley (09/2025)
+Written by Tyler Sutterley (10/2025)
 Calculates tidal elevations for correcting elevation or imagery data
 Calculates tidal currents at locations and times
 
@@ -63,6 +63,7 @@ PROGRAM DEPENDENCIES:
     interpolate.py: interpolation routines for spatial data
 
 UPDATE HISTORY:
+    Updated 10/2025: change default directory for tide models to cache
     Updated 09/2025: added wrapper for calculating solid earth tides
         using a tide potential catalog following Cartwright and Tayler (1971)
     Updated 08/2025: convert angles with numpy radians and degrees functions
@@ -175,7 +176,7 @@ __all__ = [
 _jd_mjd = 2400000.5
 
 # default working data directory for tide models
-_default_directory = pyTMD.utilities.get_data_path('data')
+_default_directory = pyTMD.utilities.get_cache_path()
 
 # PURPOSE: wrapper function for computing values
 def corrections(