pyTMD 2.2.0__tar.gz → 2.2.1__tar.gz

{pytmd-2.2.0 → pytmd-2.2.1}/CITATION.cff

@@ -36,8 +36,8 @@ url: 'https://pytmd.readthedocs.io'
 repository: 'https://pypi.org/project/pyTMD'
 repository-artifact: 'https://anaconda.org/conda-forge/pytmd'
 doi: "10.5281/zenodo.5555395"
-version: "2.2.0"
-date-released: "2024-12-20"
+version: "2.2.1"
+date-released: "2025-02-10"
 keywords:
   - Ocean Tides
   - Load Tides

{pytmd-2.2.0 → pytmd-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pyTMD
-Version: 2.2.0
+Version: 2.2.1
 Summary: Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides
 Author: Tyler Sutterley
 Author-email: tsutterl@uw.edu
@@ -204,7 +204,7 @@ Contributing
 ############
 
 This project contains work and contributions from the `scientific community <./CONTRIBUTORS.rst>`_.
-If you would like to contribute to the project, please have a look at the `open issues <https://github.com/tsutterley/pyTMD/issues>`_ and the project `code of conduct <./CODE_OF_CONDUCT.rst>`_.
+If you would like to contribute to the project, please have a look at the `open issues <https://github.com/tsutterley/pyTMD/issues>`_ and `discussions board <https://github.com/tsutterley/pyTMD/discussions>`_.
 
 Credits
 #######

{pytmd-2.2.0 → pytmd-2.2.1}/README.rst

@@ -115,7 +115,7 @@ Contributing
 ############
 
 This project contains work and contributions from the `scientific community <./CONTRIBUTORS.rst>`_.
-If you would like to contribute to the project, please have a look at the `open issues <https://github.com/tsutterley/pyTMD/issues>`_ and the project `code of conduct <./CODE_OF_CONDUCT.rst>`_.
+If you would like to contribute to the project, please have a look at the `open issues <https://github.com/tsutterley/pyTMD/issues>`_ and `discussions board <https://github.com/tsutterley/pyTMD/discussions>`_.
 
 Credits
 #######

{pytmd-2.2.0 → pytmd-2.2.1}/providers/AVISO.json

@@ -268,40 +268,40 @@
         "FES2022": {
             "format": "FES-netcdf",
             "model_file": [
-                "fes2022b/ocean_tide/2n2_fes2022.nc",
-                "fes2022b/ocean_tide/eps2_fes2022.nc",
-                "fes2022b/ocean_tide/j1_fes2022.nc",
-                "fes2022b/ocean_tide/k1_fes2022.nc",
-                "fes2022b/ocean_tide/k2_fes2022.nc",
-                "fes2022b/ocean_tide/l2_fes2022.nc",
-                "fes2022b/ocean_tide/lambda2_fes2022.nc",
-                "fes2022b/ocean_tide/m2_fes2022.nc",
-                "fes2022b/ocean_tide/m3_fes2022.nc",
-                "fes2022b/ocean_tide/m4_fes2022.nc",
-                "fes2022b/ocean_tide/m6_fes2022.nc",
-                "fes2022b/ocean_tide/m8_fes2022.nc",
-                "fes2022b/ocean_tide/mf_fes2022.nc",
-                "fes2022b/ocean_tide/mks2_fes2022.nc",
-                "fes2022b/ocean_tide/mm_fes2022.nc",
-                "fes2022b/ocean_tide/mn4_fes2022.nc",
-                "fes2022b/ocean_tide/ms4_fes2022.nc",
-                "fes2022b/ocean_tide/msf_fes2022.nc",
-                "fes2022b/ocean_tide/msqm_fes2022.nc",
-                "fes2022b/ocean_tide/mtm_fes2022.nc",
-                "fes2022b/ocean_tide/mu2_fes2022.nc",
-                "fes2022b/ocean_tide/n2_fes2022.nc",
-                "fes2022b/ocean_tide/n4_fes2022.nc",
-                "fes2022b/ocean_tide/nu2_fes2022.nc",
-                "fes2022b/ocean_tide/o1_fes2022.nc",
-                "fes2022b/ocean_tide/p1_fes2022.nc",
-                "fes2022b/ocean_tide/q1_fes2022.nc",
-                "fes2022b/ocean_tide/r2_fes2022.nc",
-                "fes2022b/ocean_tide/s1_fes2022.nc",
-                "fes2022b/ocean_tide/s2_fes2022.nc",
-                "fes2022b/ocean_tide/s4_fes2022.nc",
-                "fes2022b/ocean_tide/sa_fes2022.nc",
-                "fes2022b/ocean_tide/ssa_fes2022.nc",
-                "fes2022b/ocean_tide/t2_fes2022.nc"
+                "fes2022b/ocean_tide_20241025/2n2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/eps2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/j1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/k1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/k2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/l2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/lambda2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/m2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/m3_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/m4_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/m6_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/m8_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mf_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mks2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mm_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mn4_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/ms4_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/msf_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/msqm_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mtm_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mu2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/n2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/n4_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/nu2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/o1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/p1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/q1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/r2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/s1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/s2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/s4_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/sa_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/ssa_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/t2_fes2022.nc"
             ],
             "name": "FES2022",
             "reference": "https://doi.org/10.24400/527896/A01-2024.004",

{pytmd-2.2.0 → pytmd-2.2.1}/providers/providers.json

@@ -81,6 +81,27 @@
             "type": "z",
             "variable": "tide_ocean"
         },
+        "DTU23": {
+            "format": "GOT-ascii",
+            "model_file": [
+                "DTU23_OceanTide/DTU23/K1_DTU23.d",
+                "DTU23_OceanTide/DTU23/K2_DTU23.d",
+                "DTU23_OceanTide/DTU23/M2_DTU23.d",
+                "DTU23_OceanTide/DTU23/M4_DTU23.d",
+                "DTU23_OceanTide/DTU23/N2_DTU23.d",
+                "DTU23_OceanTide/DTU23/O1_DTU23.d",
+                "DTU23_OceanTide/DTU23/P1_DTU23.d",
+                "DTU23_OceanTide/DTU23/Q1_DTU23.d",
+                "DTU23_OceanTide/DTU23/S1_DTU23.d",
+                "DTU23_OceanTide/DTU23/S2_DTU23.d"
+            ],
+            "name": "DTU23",
+            "reference": "https://doi.org/10.3390/rs15184479",
+            "scale": 0.01,
+            "type": "z",
+            "variable": "tide_ocean",
+            "version": "2023"
+        },
         "EOT20": {
             "format": "FES-netcdf",
             "model_file": [

{pytmd-2.2.0 → pytmd-2.2.1}/pyTMD/arguments.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 arguments.py
-Written by Tyler Sutterley (12/2024)
+Written by Tyler Sutterley (02/2025)
 Calculates the nodal corrections for tidal constituents
 Modification of ARGUMENTS fortran subroutine by Richard Ray 03/1999
 
@@ -39,6 +39,7 @@ REFERENCES:
         Ocean Tides", Journal of Atmospheric and Oceanic Technology, (2002).
 
 UPDATE HISTORY:
+    Updated 02/2025: add option to make doodson numbers strings
     Updated 12/2024: added function to calculate tidal aliasing periods
     Updated 11/2024: allow variable case for Doodson number formalisms
         fix species in constituent parameters for complex tides
@@ -1542,6 +1543,8 @@ def _to_doodson_number(coef: list | np.ndarray, **kwargs):
     ----------
     coef: list or np.ndarray
         Doodson coefficients (Cartwright numbers) for constituent
+    astype: type, default float
+        Output data type for default case
     raise_error: bool, default True
         Raise exception if constituent is unsupported
 
@@ -1552,6 +1555,7 @@ def _to_doodson_number(coef: list | np.ndarray, **kwargs):
     """
     # default keyword arguments
     kwargs.setdefault('raise_error', True)
+    astype = kwargs.get('astype', float)
     # assert length and verify array
     coef = np.array(coef[:6]).astype(int)
     # add 5 to values following Doodson convention (prevent negatives)
@@ -1569,7 +1573,7 @@ def _to_doodson_number(coef: list | np.ndarray, **kwargs):
     else:
         # convert to single number and round off floating point errors
         DO = np.sum([v*10**(2-o) for o,v in enumerate(coef)])
-        return np.round(DO, decimals=3)
+        return np.round(DO, decimals=3).astype(astype)
 
 def _to_extended_doodson(coef: list | np.ndarray, **kwargs):
     """

{pytmd-2.2.0 → pytmd-2.2.1}/pyTMD/compute.py

@@ -153,6 +153,7 @@ __all__ = [
     "corrections",
     "tide_elevations",
     "tide_currents",
+    "tide_masks",
     "LPET_elevations",
     "LPT_displacements",
     "OPT_displacements",
@@ -219,7 +220,7 @@ def tide_elevations(
         CROP: bool = False,
         BOUNDS: list | np.ndarray | None = None,
         BUFFER: int | float | None = None,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -260,7 +261,7 @@ def tide_elevations(
         Boundaries for cropping tide model data
     BUFFER: int, float or NoneType, default None
         Buffer distance for cropping tide model data
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times
@@ -447,7 +448,7 @@ def tide_currents(
         CROP: bool = False,
         BOUNDS: list | np.ndarray | None = None,
         BUFFER: int | float | None = None,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -486,7 +487,7 @@ def tide_currents(
         Boundaries for cropping tide model data
     BUFFER: int, float or NoneType, default None
         Buffer distance for cropping tide model data
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times
@@ -666,7 +667,7 @@ def tide_masks(x: np.ndarray, y: np.ndarray,
         MODEL: str | None = None,
         GZIP: bool = False,
         DEFINITION_FILE: str | pathlib.Path | None = None,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         METHOD: str = 'spline'
     ):
     """
@@ -686,7 +687,7 @@ def tide_masks(x: np.ndarray, y: np.ndarray,
         Tide model files are gzip compressed
     DEFINITION_FILE: str or NoneType, default None
         Tide model definition file for use
-    EPSG: str or int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: str or int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     METHOD: str, default 'spline'
         interpolation method
@@ -794,7 +795,7 @@ def tide_masks(x: np.ndarray, y: np.ndarray,
 # PURPOSE: compute long-period equilibrium tidal elevations
 def LPET_elevations(
         x: np.ndarray, y: np.ndarray, delta_time: np.ndarray,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -811,7 +812,7 @@ def LPET_elevations(
         y-coordinates in projection EPSG
     delta_time: np.ndarray
         seconds since EPOCH or datetime array
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times
@@ -899,7 +900,7 @@ def LPET_elevations(
 # following IERS Convention (2010) guidelines
 def LPT_displacements(
         x: np.ndarray, y: np.ndarray, delta_time: np.ndarray,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -920,7 +921,7 @@ def LPT_displacements(
         y-coordinates in projection EPSG
     delta_time: np.ndarray
         seconds since EPOCH or datetime array
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times
@@ -1099,7 +1100,7 @@ def LPT_displacements(
 # following IERS Convention (2010) guidelines
 def OPT_displacements(
         x: np.ndarray, y: np.ndarray, delta_time: np.ndarray,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -1121,7 +1122,7 @@ def OPT_displacements(
         y-coordinates in projection EPSG
     delta_time: np.ndarray
         seconds since EPOCH or datetime array
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times
@@ -1327,7 +1328,7 @@ def OPT_displacements(
 # PURPOSE: compute solid earth tidal elevations
 def SET_displacements(
         x: np.ndarray, y: np.ndarray, delta_time: np.ndarray,
-        EPSG: str | int = 3031,
+        EPSG: str | int = 4326,
         EPOCH: list | tuple = (2000, 1, 1, 0, 0, 0),
         TYPE: str | None = 'drift',
         TIME: str = 'UTC',
@@ -1348,7 +1349,7 @@ def SET_displacements(
         y-coordinates in projection EPSG
     delta_time: np.ndarray
         seconds since EPOCH or datetime array
-    EPSG: int, default: 3031 (Polar Stereographic South, WGS84)
+    EPSG: int, default: 4326 (WGS84 Latitude and Longitude)
         Input coordinate system
     EPOCH: tuple, default (2000,1,1,0,0,0)
         Time period for calculating delta times

{pytmd-2.2.0 → pytmd-2.2.1}/pyTMD/data/database.json

@@ -985,6 +985,27 @@
             "type": "z",
             "variable": "tide_load"
         },
+        "DTU23": {
+            "format": "GOT-ascii",
+            "model_file": [
+                "DTU23_OceanTide/DTU23/K1_DTU23.d",
+                "DTU23_OceanTide/DTU23/K2_DTU23.d",
+                "DTU23_OceanTide/DTU23/M2_DTU23.d",
+                "DTU23_OceanTide/DTU23/M4_DTU23.d",
+                "DTU23_OceanTide/DTU23/N2_DTU23.d",
+                "DTU23_OceanTide/DTU23/O1_DTU23.d",
+                "DTU23_OceanTide/DTU23/P1_DTU23.d",
+                "DTU23_OceanTide/DTU23/Q1_DTU23.d",
+                "DTU23_OceanTide/DTU23/S1_DTU23.d",
+                "DTU23_OceanTide/DTU23/S2_DTU23.d"
+            ],
+            "name": "DTU23",
+            "reference": "https://doi.org/10.3390/rs15184479",
+            "scale": 0.01,
+            "type": "z",
+            "variable": "tide_ocean",
+            "version": "2023"
+        },
         "EOT20": {
             "format": "FES-netcdf",
             "model_file": [
@@ -1222,40 +1243,40 @@
         "FES2022": {
             "format": "FES-netcdf",
             "model_file": [
-                "fes2022b/ocean_tide/2n2_fes2022.nc",
-                "fes2022b/ocean_tide/eps2_fes2022.nc",
-                "fes2022b/ocean_tide/j1_fes2022.nc",
-                "fes2022b/ocean_tide/k1_fes2022.nc",
-                "fes2022b/ocean_tide/k2_fes2022.nc",
-                "fes2022b/ocean_tide/l2_fes2022.nc",
-                "fes2022b/ocean_tide/lambda2_fes2022.nc",
-                "fes2022b/ocean_tide/m2_fes2022.nc",
-                "fes2022b/ocean_tide/m3_fes2022.nc",
-                "fes2022b/ocean_tide/m4_fes2022.nc",
-                "fes2022b/ocean_tide/m6_fes2022.nc",
-                "fes2022b/ocean_tide/m8_fes2022.nc",
-                "fes2022b/ocean_tide/mf_fes2022.nc",
-                "fes2022b/ocean_tide/mks2_fes2022.nc",
-                "fes2022b/ocean_tide/mm_fes2022.nc",
-                "fes2022b/ocean_tide/mn4_fes2022.nc",
-                "fes2022b/ocean_tide/ms4_fes2022.nc",
-                "fes2022b/ocean_tide/msf_fes2022.nc",
-                "fes2022b/ocean_tide/msqm_fes2022.nc",
-                "fes2022b/ocean_tide/mtm_fes2022.nc",
-                "fes2022b/ocean_tide/mu2_fes2022.nc",
-                "fes2022b/ocean_tide/n2_fes2022.nc",
-                "fes2022b/ocean_tide/n4_fes2022.nc",
-                "fes2022b/ocean_tide/nu2_fes2022.nc",
-                "fes2022b/ocean_tide/o1_fes2022.nc",
-                "fes2022b/ocean_tide/p1_fes2022.nc",
-                "fes2022b/ocean_tide/q1_fes2022.nc",
-                "fes2022b/ocean_tide/r2_fes2022.nc",
-                "fes2022b/ocean_tide/s1_fes2022.nc",
-                "fes2022b/ocean_tide/s2_fes2022.nc",
-                "fes2022b/ocean_tide/s4_fes2022.nc",
-                "fes2022b/ocean_tide/sa_fes2022.nc",
-                "fes2022b/ocean_tide/ssa_fes2022.nc",
-                "fes2022b/ocean_tide/t2_fes2022.nc"
+                "fes2022b/ocean_tide_20241025/2n2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/eps2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/j1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/k1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/k2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/l2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/lambda2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/m2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/m3_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/m4_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/m6_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/m8_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mf_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mks2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mm_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mn4_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/ms4_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/msf_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/msqm_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mtm_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/mu2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/n2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/n4_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/nu2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/o1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/p1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/q1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/r2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/s1_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/s2_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/s4_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/sa_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/ssa_fes2022.nc",
+                "fes2022b/ocean_tide_20241025/t2_fes2022.nc"
             ],
             "name": "FES2022",
             "reference": "https://doi.org/10.24400/527896/A01-2024.004",

{pytmd-2.2.0 → pytmd-2.2.1}/pyTMD/io/model.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 model.py
-Written by Tyler Sutterley (11/2024)
+Written by Tyler Sutterley (02/2025)
 Retrieves tide model parameters for named tide models and
     from model definition files
 
@@ -11,6 +11,7 @@ PYTHON DEPENDENCIES:
         https://numpy.org/doc/stable/user/numpy-for-matlab-users.html
 
 UPDATE HISTORY:
+    Updated 02/2025: fixed missing grid kwarg for reading from TMD3 models 
     Updated 11/2024: use Love numbers for long-period tides in node equilibrium
     Updated 10/2024: add wrapper functions to read and interpolate constants
         add functions to append node tide equilibrium values to amplitudes
@@ -1077,7 +1078,8 @@ class model:
                 model_file = self.model_file
             # read tidal constants for model type
             c = OTIS.read_constants(self.grid_file,
-                model_file, self.projection, **kwargs)
+                model_file, self.projection,
+                grid=self.file_format, **kwargs)
         elif self.format in ('ATLAS-netcdf',):
             # extract model file in case of currents
             if isinstance(self.model_file, dict):

{pytmd-2.2.0 → pytmd-2.2.1}/pyTMD/math.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 math.py
-Written by Tyler Sutterley (12/2024)
+Written by Tyler Sutterley (01/2025)
 Special functions of mathematical physics
 
 PYTHON DEPENDENCIES:
@@ -12,6 +12,7 @@ PYTHON DEPENDENCIES:
         https://docs.scipy.org/doc/
 
 UPDATE HISTORY:
+    Updated 01/2025: added function for fully-normalized Legendre polynomials
     Updated 12/2024: added function to calculate an aliasing frequency
     Written 11/2024
 """
@@ -26,6 +27,7 @@ __all__ = [
     "rotate",
     "aliasing",
     "legendre",
+    "assoc_legendre",
     "sph_harm"
 ]
 
@@ -141,7 +143,7 @@ def legendre(
     Parameters
     ----------
     l: int
-        degree of the Legrendre polynomials (0 to 3)
+        degree of the Legendre polynomials (0 to 3)
     x: np.ndarray
         elements ranging from -1 to 1
 
@@ -188,6 +190,58 @@ def legendre(
     else:
         return np.pow(-1.0, m)*Plm[l, m, :]
 
+def assoc_legendre(lmax, x):
+    """
+    Computes fully-normalized associated Legendre Polynomials using a
+    standard forward-column method :cite:p:`Colombo:1981vh`
+    :cite:p:`HofmannWellenhof:2006hy`
+
+    Parameters
+    ----------
+    lmax: int
+        maximum degree and order of Legendre polynomials
+    x: np.ndarray
+        elements ranging from -1 to 1
+
+        Typically ``cos(theta)``, where ``theta`` is the colatitude in radians
+
+    Returns
+    -------
+    Plm: np.ndarray
+        fully-normalized Legendre polynomials
+    """
+    # verify values are integers
+    lmax = np.int64(lmax)
+    # verify dimensions
+    singular_values = (np.ndim(x) == 0)
+    x = np.atleast_1d(x).flatten()
+    # if x is the cos of colatitude, u is the sine
+    u = np.sqrt(1.0 - x**2)
+    # size of the x array
+    nx = len(x)
+    # allocate for associated legendre functions
+    Plm = np.zeros((lmax+1,lmax+1,nx))
+    # initial polynomials for the recursion
+    Plm[0,0,:] = 1.0
+    Plm[1,0,:] = np.sqrt(3.0)*x
+    Plm[1,1,:] = np.sqrt(3.0)*u
+    for l in range(2, lmax+1):
+        # normalization factor
+        norm = np.sqrt(2.0*l+1.0)
+        for m in range(0, l):
+            # zonal and tesseral terms (non-sectorial)
+            a = np.sqrt((2.0*l-1.0)/((l-m)*(l+m)))
+            b = np.sqrt((l+m-1.0)*(l-m-1.0)/((l-m)*(l+m)*(2.0*l-3.0)))
+            Plm[l,m,:] = a*norm*x*Plm[l-1,m,:] - b*norm*Plm[l-2,m,:]
+        # sectorial terms: serve as seed values for the recursion
+        # starting with P00 and P11 (outside the loop)
+        Plm[l,l,:] = u*norm*np.sqrt(1.0/(2.0*l))*Plm[l-1,l-1,:]
+    # return values
+    if singular_values:
+        return Plm[:, :, 0]
+    else:
+        return Plm
+
 def sph_harm(
         l: int,
         theta: np.ndarray,

{pytmd-2.2.0 → pytmd-2.2.1}/pyTMD/predict.py

@@ -108,7 +108,8 @@ def map(t: float | np.ndarray,
         corrections: str = 'OTIS'
     ):
     """
-    Predict tides at a single time using harmonic constants :cite:p:`Egbert:2002ge`
+    Predict tides at a single time using harmonic
+    constants :cite:p:`Egbert:2002ge`
 
     Parameters
     ----------
@@ -280,8 +281,9 @@ def infer_minor(
     ):
     """
     Infer the tidal values for minor constituents using their
-    relation with major constituents :cite:p:`Doodson:1941td` :cite:p:`Schureman:1958ty`
-    :cite:p:`Foreman:1989dt` :cite:p:`Egbert:2002ge`
+    relation with major constituents :cite:p:`Doodson:1941td`
+    :cite:p:`Schureman:1958ty` :cite:p:`Foreman:1989dt`
+    :cite:p:`Egbert:2002ge`
 
     Parameters
     ----------
@@ -497,6 +499,7 @@ def _infer_semi_diurnal(
     """
     # set default keyword arguments
     kwargs.setdefault('deltat', 0.0)
+    kwargs.setdefault('corrections', 'GOT')
     kwargs.setdefault('method', 'linear')
     kwargs.setdefault('raise_exception', False)
     # list of minor constituents
@@ -597,8 +600,9 @@ def _infer_semi_diurnal(
             Ainv = np.array([[3.3133, -4.2538, 1.9405],
                 [-3.3133, 4.2538, -0.9405],
                 [1.5018, -3.2579, 1.7561]])
-            coef = np.inner(Ainv, z)
-            # convert frequency to cycles per day
+            coef = np.dot(Ainv, z.T)
+            # convert frequency to radians per 48 hours
+            # following Munk and Cartwright (1966)
             f = 2.0*omega[k]*86400.0
             # calculate interpolated values for constituent
             interp = coef[0,:] + coef[1,:]*np.cos(f) + coef[2,:]*np.sin(f)
@@ -621,7 +625,8 @@ def _infer_diurnal(
     Infer the tidal values for diurnal minor constituents
     using their relation with major constituents taking into
     account resonance due to free core nutation
-    :cite:p:`Munk:1966go` :cite:p:`Ray:2017jx` :cite:p:`Wahr:1981if` :cite:p:`Cartwright:1973em`
+    :cite:p:`Munk:1966go` :cite:p:`Ray:2017jx` :cite:p:`Wahr:1981if`
+    :cite:p:`Cartwright:1973em`
 
     Parameters
     ----------
@@ -650,6 +655,7 @@ def _infer_diurnal(
     """
     # set default keyword arguments
     kwargs.setdefault('deltat', 0.0)
+    kwargs.setdefault('corrections', 'GOT')
     kwargs.setdefault('method', 'linear')
     kwargs.setdefault('raise_exception', False)
     # list of minor constituents
@@ -761,8 +767,9 @@ def _infer_diurnal(
             Ainv = np.array([[3.1214, -3.8494, 1.728],
                 [-3.1727, 3.9559, -0.7832],
                 [1.438, -3.0297, 1.5917]])
-            coef = np.inner(Ainv, z)
-            # convert frequency to cycles per day
+            coef = np.dot(Ainv, z.T)
+            # convert frequency to radians per 48 hours
+            # following Munk and Cartwright (1966)
             f = 2.0*omega[k]*86400.0
             # calculate interpolated values for constituent
             interp = coef[0,:] + coef[1,:]*np.cos(f) + coef[2,:]*np.sin(f)
@@ -1259,7 +1266,8 @@ def solid_earth_tide(
     ):
     """
     Compute the solid Earth tides due to the gravitational attraction of
-    the moon and sun :cite:p:`Mathews:1991kv` :cite:p:`Mathews:1997js` :cite:p:`Ries:1992ip` :cite:p:`Wahr:1981ea`
+    the moon and sun :cite:p:`Mathews:1991kv` :cite:p:`Mathews:1997js`
+    :cite:p:`Ries:1992ip` :cite:p:`Wahr:1981ea`
 
     Parameters
     ----------

{pytmd-2.2.0 → pytmd-2.2.1}/pyTMD/utilities.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 utilities.py
-Written by Tyler Sutterley (08/2024)
+Written by Tyler Sutterley (01/2025)
 Download and management utilities for syncing time and auxiliary files
 
 PYTHON DEPENDENCIES:
@@ -9,6 +9,7 @@ PYTHON DEPENDENCIES:
         https://pypi.python.org/pypi/lxml
 
 UPDATE HISTORY:
+    Updated 01/2025: added function to list a directory from the UHSLC
     Updated 08/2024: generalize hash function to use any available algorithm
     Updated 07/2024: added function to parse JSON responses from https
     Updated 06/2024: make default case for an import exception be a class
@@ -112,7 +113,8 @@ __all__ = [
     "cddis_list",
     "from_cddis",
     "iers_list",
-    "from_jpl_ssd"
+    "from_jpl_ssd",
+    "uhslc_list"
 ]
 
 # PURPOSE: get absolute path within a package from a relative path
@@ -1567,3 +1569,67 @@ def from_jpl_ssd(
     logging.info('Downloading JPL Planetary Ephemeride Kernel File')
     from_http(HOST, timeout=timeout, context=context, local=local,
         hash=hash, chunk=chunk, verbose=verbose, mode=mode)
+
+# PURPOSE: list a directory on the University of Hawaii SLC Server
+def uhslc_list(
+        HOST: str | list,
+        timeout: int | None = None,
+        context: ssl.SSLContext = _default_ssl_context,
+        parser = lxml.etree.HTMLParser(),
+        pattern: str = '',
+        sort: bool = False
+    ):
+    """
+    List a directory from the University of Hawaii Sea Level Center
+
+    Parameters
+    ----------
+    HOST: str or list
+        remote http host path
+    timeout: int or NoneType, default None
+        timeout in seconds for blocking operations
+    context: obj, default pyTMD.utilities._default_ssl_context
+        SSL context for ``urllib`` opener object
+    parser: obj, default lxml.etree.HTMLParser()
+        HTML parser for ``lxml``
+    pattern: str, default ''
+        regular expression pattern for reducing list
+    sort: bool, default False
+        sort output list
+
+    Returns
+    -------
+    colnames: list
+        column names in a directory
+    """
+    # verify inputs for remote http host
+    if isinstance(HOST, str):
+        HOST = url_split(HOST)
+    # try listing from http
+    try:
+        # Create and submit request.
+        request = urllib2.Request(posixpath.join(*HOST))
+        response = urllib2.urlopen(request, timeout=timeout, context=context)
+    except urllib2.HTTPError as exc:
+        logging.debug(exc.code)
+        raise RuntimeError(exc.reason) from exc
+    except urllib2.URLError as exc:
+        logging.debug(exc.reason)
+        msg = 'List error from {0}'.format(posixpath.join(*HOST))
+        raise Exception(msg) from exc
+    else:
+        # read and parse request for files
+        tree = lxml.etree.parse(response, parser)
+        colnames = tree.xpath('//a/text()')
+        # reduce using regular expression pattern
+        if pattern:
+            i = [i for i,f in enumerate(colnames) if re.search(pattern, f)]
+            # reduce list of column names
+            colnames = [colnames[indice] for indice in i]
+        # sort the list
+        if sort:
+            i = [i for i,j in sorted(enumerate(colnames), key=lambda i: i[1])]
+            # sort list of column names
+            colnames = [colnames[indice] for indice in i]
+        # return the list of column names
+        return colnames

{pytmd-2.2.0 → pytmd-2.2.1}/pyTMD.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pyTMD
-Version: 2.2.0
+Version: 2.2.1
 Summary: Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides
 Author: Tyler Sutterley
 Author-email: tsutterl@uw.edu
@@ -204,7 +204,7 @@ Contributing
 ############
 
 This project contains work and contributions from the `scientific community <./CONTRIBUTORS.rst>`_.
-If you would like to contribute to the project, please have a look at the `open issues <https://github.com/tsutterley/pyTMD/issues>`_ and the project `code of conduct <./CODE_OF_CONDUCT.rst>`_.
+If you would like to contribute to the project, please have a look at the `open issues <https://github.com/tsutterley/pyTMD/issues>`_ and `discussions board <https://github.com/tsutterley/pyTMD/discussions>`_.
 
 Credits
 #######

{pytmd-2.2.0 → pytmd-2.2.1}/pyproject.toml

@@ -101,3 +101,6 @@ omit = [
 [tool.coverage.report]
 show_missing = true
 precision = 2
+
+[tool.ruff]
+line-length = 80

{pytmd-2.2.0 → pytmd-2.2.1}/scripts/aviso_fes_tides.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 aviso_fes_tides.py
-Written by Tyler Sutterley (07/2024)
+Written by Tyler Sutterley (01/2025)
 Downloads the FES (Finite Element Solution) global tide model from AVISO
 Decompresses the model tar files into the constituent files and auxiliary files
     https://www.aviso.altimetry.fr/data/products/auxiliary-products/
@@ -40,6 +40,8 @@ PROGRAM DEPENDENCIES:
     utilities.py: download and management utilities for syncing files
 
 UPDATE HISTORY:
+    Updated 01/2025: new ocean tide directory for latest FES2022 version
+        scrubbed use of pathlib.os to just use os directly
     Updated 07/2024: added list and download for FES2022 tide model
         compare modification times with remote to not overwrite files
     Updated 05/2023: added option to change connection timeout
@@ -234,7 +236,9 @@ def aviso_fes_list(MODEL, f, logger,
     FES = {}
     # 2022 model
     FES['FES2022'] = []
-    FES['FES2022'].append(['fes2022b','ocean_tide'])
+    # updated directory for ocean tide model
+    # latest version fixes the valid_max attribute for longitudes
+    FES['FES2022'].append(['fes2022b','ocean_tide_20241025'])
     if LOAD:
         FES['FES2022'].append(['fes2022b','load_tide'])
     if EXTRAPOLATED:
@@ -320,7 +324,7 @@ def ftp_download(logger, ftp, remote_path, local_dir,
                 shutil.copyfileobj(fi, fo)
             # get last modified date of remote file within tar file
             # keep remote modification time of file and local access time
-            pathlib.os.utime(local_file, (local_file.stat().st_atime, m.mtime))
+            os.utime(local_file, (local_file.stat().st_atime, m.mtime))
             local_file.chmod(mode=MODE)
     elif LZMA:
         # get last modified date of remote file and convert into unix time
@@ -350,7 +354,7 @@ def ftp_download(logger, ftp, remote_path, local_dir,
             shutil.copyfileobj(fi, fo)
         # get last modified date of remote file within tar file
         # keep remote modification time of file and local access time
-        pathlib.os.utime(local_file, (local_file.stat().st_atime, mtime))
+        os.utime(local_file, (local_file.stat().st_atime, mtime))
         local_file.chmod(mode=MODE)
     else:
         # copy readme and uncompressed files directly
@@ -375,7 +379,7 @@ def ftp_download(logger, ftp, remote_path, local_dir,
         with opener(local_file, 'wb') as f:
             ftp.retrbinary(f'RETR {remote_file}', f.write, blocksize=CHUNK)
         # keep remote modification time of file and local access time
-        pathlib.os.utime(local_file, (local_file.stat().st_atime, mtime))
+        os.utime(local_file, (local_file.stat().st_atime, mtime))
         local_file.chmod(mode=MODE)
 
 # PURPOSE: compare the modification time of two files

{pytmd-2.2.0 → pytmd-2.2.1}/scripts/gsfc_got_tides.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 gsfc_got_tides.py
-Written by Tyler Sutterley (09/2024)
+Written by Tyler Sutterley (01/2025)
 Download GSFC Global Ocean Tide (GOT) models
 
 CALLING SEQUENCE:
@@ -32,12 +32,14 @@ PROGRAM DEPENDENCIES:
     utilities.py: download and management utilities for syncing files
 
 UPDATE HISTORY:
+    Updated 01/2025: scrubbed use of pathlib.os to just use os directly
     Updated 09/2024: added Ray and Erofeeva (2014) long-period tide model
     Updated 08/2024: keep prime nomenclature for 3rd degree tides
     Written 07/2024
 """
 from __future__ import print_function, annotations
 
+import os
 import re
 import gzip
 import shutil
@@ -120,7 +122,7 @@ def gsfc_got_tides(MODEL: str,
             shutil.copyfileobj(fi, fo)
         # get last modified date of remote file within tar file
         # keep remote modification time of file and local access time
-        pathlib.os.utime(local_file, (local_file.stat().st_atime, m.mtime))
+        os.utime(local_file, (local_file.stat().st_atime, m.mtime))
         local_file.chmod(mode=MODE)
 
 # PURPOSE: compare the modification time of two files

{pytmd-2.2.0 → pytmd-2.2.1}/scripts/verify_box_tpxo.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 verify_box_tpxo.py
-Written by Tyler Sutterley (09/2024)
+Written by Tyler Sutterley (01/2025)
 Verifies downloaded TPXO9-atlas global tide models from the box file
     sharing service
 
@@ -26,6 +26,7 @@ REFERENCE:
     https://developer.box.com/guides/
 
 UPDATE HISTORY:
+    Updated 01/2025: scrubbed use of pathlib.os to just use os directly
     Updated 09/2024: use model class to define output directory
     Updated 04/2023: using pathlib to define and expand paths
     Updated 01/2023: use default context from utilities module
@@ -38,6 +39,7 @@ UPDATE HISTORY:
 """
 from __future__ import print_function
 
+import os
 import re
 import json
 import logging
@@ -132,7 +134,7 @@ def verify_box_tpxo(tide_dir, folder_id, TIDE_MODEL=None,
             logger.critical(f'Local checksum: {sha1}')
             raise Exception('Checksum verification failed')
         # keep remote modification time of file and local access time
-        pathlib.os.utime(local, (local.stat().st_atime, remote_mtime))
+        os.utime(local, (local.stat().st_atime, remote_mtime))
         # change the permissions mode of the local file
         local.chmod(mode=MODE)
 

pytmd-2.2.1/version.txt

@@ -0,0 +1 @@
+2.2.1

pytmd-2.2.0/version.txt

@@ -1 +0,0 @@
-2.2.0