pyTMD 2.2.5__tar.gz → 2.2.6__tar.gz

{pytmd-2.2.5 → pytmd-2.2.6}/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.5"
-date-released: "2025-06-23"
+version: "2.2.6"
+date-released: "2025-07-24"
 keywords:
   - Ocean Tides
   - Load Tides

{pytmd-2.2.5 → pytmd-2.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyTMD
-Version: 2.2.5
+Version: 2.2.6
 Summary: Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides
 Author: Tyler Sutterley
 Author-email: tsutterl@uw.edu

{pytmd-2.2.5 → pytmd-2.2.6}/pyTMD/astro.py

@@ -49,7 +49,7 @@ UPDATE HISTORY:
     Updated 08/2020: change time variable names to not overwrite functions
     Updated 07/2020: added function docstrings
     Updated 07/2018: added option ASTRO5 to use coefficients from Richard Ray
-        for use with the GSFC Global Ocean Tides (GOT) model
+        for use with the Goddard Ocean Tides (GOT) model
         added longitude of solar perigee (Ps) as an additional output
     Updated 09/2017: added option MEEUS to use additional coefficients
         from Meeus Astronomical Algorithms to calculate mean longitudes
@@ -503,7 +503,7 @@ def mean_obliquity(MJD: np.ndarray):
     return atr*polynomial_sum(epsilon0, T)
 
 def equation_of_time(MJD: np.ndarray):
-    """Approximate calcuation of the difference between apparent and
+    """Approximate calculation of the difference between apparent and
     mean solar times :cite:p:`Meeus:1991vh,Urban:2013vl`
 
     Parameters
@@ -975,7 +975,7 @@ def _icrs_rotation_matrix(
         include_polar_motion: bool = True
     ):
     """
-    Rotation matrix for tranforming from the
+    Rotation matrix for transforming from the
     International Celestial Reference System (ICRS)
     to the International Terrestrial Reference System (ITRS)
     :cite:p:`Capitaine:2003fx,Capitaine:2003fw,Petit:2010tp`

{pytmd-2.2.5 → pytmd-2.2.6}/pyTMD/compute.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 compute.py
-Written by Tyler Sutterley (05/2025)
+Written by Tyler Sutterley (07/2025)
 Calculates tidal elevations for correcting elevation or imagery data
 Calculates tidal currents at locations and times
 
@@ -62,6 +62,7 @@ PROGRAM DEPENDENCIES:
     interpolate.py: interpolation routines for spatial data
 
 UPDATE HISTORY:
+    Updated 07/2025: mask mean pole values prior to valid epoch of convention
     Updated 05/2025: added option to select constituents to read from model
     Updated 12/2024: moved check points function as compute.tide_masks
     Updated 11/2024: expose buffer distance for cropping tide model data
@@ -1064,9 +1065,10 @@ def LPT_displacements(
             )
             # calculate components of load pole tides
             S = np.einsum('ti...,tji...->tj...', dxi, R)
+            smask = np.reshape(np.any(dxi.mask, axis=1), (ny,nx))
             # reshape to output dimensions
             Srad.data[:,:,i] = np.reshape(S[:,2], (ny,nx))
-            Srad.mask[:,:,i] = np.isnan(Srad.data[:,:,i])
+            Srad.mask[:,:,i] = np.isnan(Srad.data[:,:,i]) | smask
     elif (TYPE == 'drift'):
         # calculate load pole tides in cartesian coordinates
         XYZ = np.c_[X, Y, Z]
@@ -1080,10 +1082,11 @@ def LPT_displacements(
         )
         # calculate components of load pole tides
         S = np.einsum('ti...,tji...->tj...', dxi, R)
+        smask = np.any(dxi.mask, axis=1)
         # reshape to output dimensions
         Srad = np.ma.zeros((nt), fill_value=FILL_VALUE)
         Srad.data[:] = S[:,2].copy()
-        Srad.mask = np.isnan(Srad.data)
+        Srad.mask = np.isnan(Srad.data) | smask
     elif (TYPE == 'time series'):
         nstation = len(x)
         Srad = np.ma.zeros((nstation,nt), fill_value=FILL_VALUE)
@@ -1102,9 +1105,10 @@ def LPT_displacements(
             )
             # calculate components of load pole tides
             S = np.einsum('ti...,ji...->tj...', dxi, R[s,:,:])
+            smask = np.any(dxi.mask, axis=1)
             # reshape to output dimensions
             Srad.data[s,:] = S[:,2].copy()
-            Srad.mask[s,:] = np.isnan(Srad.data[s,:])
+            Srad.mask[s,:] = np.isnan(Srad.data[s,:]) | smask
 
     # replace invalid data with fill values
     Srad.data[Srad.mask] = Srad.fill_value
@@ -1288,9 +1292,10 @@ def OPT_displacements(
             )
             # calculate components of ocean pole tides
             U = np.einsum('ti...,tji...->tj...', dxi, Rinv)
+            umask = np.reshape(np.any(dxi.mask, axis=1), (ny,nx))
             # reshape to output dimensions
             Urad.data[:,:,i] = np.reshape(U[:,2], (ny,nx))
-            Urad.mask[:,:,i] = np.isnan(Urad.data[:,:,i])
+            Urad.mask[:,:,i] = np.isnan(Urad.data[:,:,i]) | umask
     elif (TYPE == 'drift'):
         # calculate ocean pole tides in cartesian coordinates
         XYZ = np.c_[X, Y, Z]
@@ -1306,10 +1311,11 @@ def OPT_displacements(
         )
         # calculate components of ocean pole tides
         U = np.einsum('ti...,tji...->tj...', dxi, Rinv)
+        umask = np.any(dxi.mask, axis=1)
         # convert to masked array
         Urad = np.ma.zeros((nt), fill_value=FILL_VALUE)
         Urad.data[:] = U[:,2].copy()
-        Urad.mask = np.isnan(Urad.data)
+        Urad.mask = np.isnan(Urad.data) | umask
     elif (TYPE == 'time series'):
         nstation = len(x)
         Urad = np.ma.zeros((nstation,nt), fill_value=FILL_VALUE)
@@ -1331,9 +1337,10 @@ def OPT_displacements(
             )
             # calculate components of ocean pole tides
             U = np.einsum('ti...,ji...->tj...', dxi, Rinv[s,:,:])
+            umask = np.any(dxi.mask, axis=1)
             # reshape to output dimensions
             Urad.data[s,:] = U[:,2].copy()
-            Urad.mask[s,:] = np.isnan(Urad.data[s,:])
+            Urad.mask[s,:] = np.isnan(Urad.data[s,:]) | umask
 
     # replace invalid data with fill values
     Urad.data[Urad.mask] = Urad.fill_value

{pytmd-2.2.5 → pytmd-2.2.6}/pyTMD/crs.py

@@ -189,7 +189,7 @@ class crs:
         PROJECTION: int, str or dict
             Coordinate Reference System
         """
-        # coordinate reference system dictoinary
+        # coordinate reference system dictionary
         try:
             CRS = pyproj.CRS.from_user_input(PROJECTION)
         except (ValueError, pyproj.exceptions.CRSError):

{pytmd-2.2.5 → pytmd-2.2.6}/pyTMD/io/GOT.py

@@ -3,10 +3,10 @@ u"""
 GOT.py
 Written by Tyler Sutterley (11/2024)
 
-Reads files for Richard Ray's Global Ocean Tide (GOT) models and makes initial
-    calculations to run the tide program
-Includes functions to extract tidal harmonic constants out of a tidal model for
-    given locations
+Reads files for Richard Ray's Goddard Ocean Tide (GOT) models and makes
+    initial calculations to run the tide program
+Includes functions to extract tidal harmonic constants out of a tidal
+    model for given locations
 
 INPUTS:
     ilon: longitude to interpolate
@@ -123,7 +123,7 @@ def extract_constants(
         **kwargs
     ):
     """
-    Reads files for Richard Ray's Global Ocean Tide (GOT) models
+    Reads files for Richard Ray's Goddard Ocean Tide (GOT) models
 
     Makes initial calculations to run the tide program
 
@@ -315,7 +315,7 @@ def read_constants(
         **kwargs
     ):
     """
-    Reads files for Richard Ray's Global Ocean Tide (GOT) models
+    Reads files for Richard Ray's Goddard Ocean Tide (GOT) models
 
     Parameters
     ----------
@@ -540,7 +540,7 @@ def read_ascii_file(
         **kwargs
     ):
     """
-    Read Richard Ray's Global Ocean Tide (GOT) model file
+    Read Richard Ray's Goddard Ocean Tide (GOT) model file
 
     Parameters
     ----------
@@ -625,7 +625,7 @@ def read_netcdf_file(
         **kwargs
     ):
     """
-    Read Richard Ray's Global Ocean Tide (GOT) netCDF4 model file
+    Read Richard Ray's Goddard Ocean Tide (GOT) netCDF4 model file
 
     Parameters
     ----------

{pytmd-2.2.5 → pytmd-2.2.6}/pyTMD/io/model.py

@@ -54,7 +54,7 @@ UPDATE HISTORY:
     Updated 12/2022: moved to io and added deprecation warning to old
     Updated 11/2022: use f-strings for formatting verbose or ascii output
     Updated 06/2022: added Greenland 1km model (Gr1kmTM) to list of models
-        updated citation url for Global Ocean Tide (GOT) models
+        updated citation url for Goddard Ocean Tide (GOT) models
     Updated 05/2022: added ESR CATS2022 to list of models
         added attribute for flexure fields being available for model
     Updated 04/2022: updated docstrings to numpy documentation format

{pytmd-2.2.5 → pytmd-2.2.6}/pyTMD/predict.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 predict.py
-Written by Tyler Sutterley (05/2025)
+Written by Tyler Sutterley (07/2025)
 Prediction routines for ocean, load, equilibrium and solid earth tides
 
 REFERENCES:
@@ -22,6 +22,9 @@ PROGRAM DEPENDENCIES:
     spatial.py: utilities for working with geospatial data
 
 UPDATE HISTORY:
+    Updated 07/2025: revert free-to-mean conversion to April 2023 version
+        revert load pole tide to IERS 1996 convention definitions
+        mask mean pole values prior to valid epoch of convention
     Updated 05/2025: pass keyword arguments to nodal corrections functions
     Updated 03/2025: changed argument for method calculating mean longitudes
     Updated 02/2025: verify dimensions of harmonic constants
@@ -169,7 +172,7 @@ def map(t: float | np.ndarray,
     # return the tidal elevation after removing singleton dimensions
     return np.squeeze(ht)
 
-# PURPOSE: Predict tides at drift bouys or altimetry points
+# PURPOSE: Predict tides at drift buoys or altimetry points
 def drift(t: float | np.ndarray,
         hc: np.ndarray,
         constituents: list | np.ndarray,
@@ -1116,7 +1119,7 @@ def load_pole_tide(
     # degrees and arcseconds to radians
     dtr = np.pi/180.0
     atr = np.pi/648000.0
-    # convert time to Terrestial Time (TT)
+    # convert time to Terrestrial Time (TT)
     tt = t + _jd_tide + deltat
     # convert time to Modified Julian Days (MJD)
     MJD = tt - _jd_mjd
@@ -1156,9 +1159,9 @@ def load_pole_tide(
     # calculate pole tide displacements (meters)
     S = np.zeros((n, 3))
     # pole tide displacements in latitude, longitude, and radial directions
-    S[:,0] = dfactor[:,0]*np.cos(2.0*theta)*(mx*np.cos(phi) + my*np.sin(phi))
-    S[:,1] = dfactor[:,1]*np.cos(theta)*(mx*np.sin(phi) - my*np.cos(phi))
-    S[:,2] = dfactor[:,2]*np.sin(2.0*theta)*(mx*np.cos(phi) + my*np.sin(phi))
+    S[:,0] = dfactor[:,0]*np.cos(2.0*theta)*(mx*np.cos(phi) - my*np.sin(phi))
+    S[:,1] = dfactor[:,1]*np.cos(theta)*(mx*np.sin(phi) + my*np.cos(phi))
+    S[:,2] = dfactor[:,2]*np.sin(2.0*theta)*(mx*np.cos(phi) - my*np.sin(phi))
 
     # rotation matrix
     R = np.zeros((3, 3, n))
@@ -1171,7 +1174,10 @@ def load_pole_tide(
     R[2,0,:] = -np.sin(theta)
     R[2,2,:] = np.cos(theta)
     # rotate displacements to ECEF coordinates
-    dxt = np.einsum('ti...,jit...->tj...', S, R)
+    dxt = np.ma.zeros((n, 3))
+    dxt[:,:] = np.einsum('ti...,jit...->tj...', S, R)
+    # use mask from mean pole estimates
+    dxt.mask = np.broadcast_to(np.logical_not(fl[:,None]), (n,3))
 
     # return the pole tide displacements
     # in Cartesian coordinates
@@ -1233,7 +1239,7 @@ def ocean_pole_tide(
     # degrees and arcseconds to radians
     dtr = np.pi/180.0
     atr = np.pi/648000.0
-    # convert time to Terrestial Time (TT)
+    # convert time to Terrestrial Time (TT)
     tt = t + _jd_tide + deltat
     # convert time to Modified Julian Days (MJD)
     MJD = tt - _jd_mjd
@@ -1271,7 +1277,9 @@ def ocean_pole_tide(
     # number of points
     n = np.maximum(len(time_decimal), len(theta))
     # calculate ocean pole tide displacements (meters)
-    dxt = np.zeros((n, 3))
+    dxt = np.ma.zeros((n, 3))
+    # use mask from mean pole estimates
+    dxt.mask = np.broadcast_to(np.logical_not(fl[:,None]), (n,3))
     for i in range(3):
         dxt[:,i] = K*atr*np.real(
             (mx*g2.real + my*g2.imag)*UXYZ.real[:,i] +
@@ -1757,8 +1765,8 @@ def _free_to_mean(
     dr = dR0*(3.0/2.0*sinphi**2 - 1.0/2.0)
     dn = 2.0*dN0*cosphi*sinphi
     # compute as an additive correction (Mathews et al. 1997)
-    DX = dr*cosla*cosphi - dn*cosla*sinphi
-    DY = dr*sinla*cosphi - dn*sinla*sinphi
-    DZ = dr*sinphi + dn*cosphi
+    DX = -dr*cosla*cosphi + dn*cosla*sinphi
+    DY = -dr*sinla*cosphi + dn*sinla*sinphi
+    DZ = -dr*sinphi - dn*cosphi
     # return the corrections
     return np.c_[DX, DY, DZ]

{pytmd-2.2.5 → pytmd-2.2.6}/pyTMD/utilities.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 utilities.py
-Written by Tyler Sutterley (01/2025)
+Written by Tyler Sutterley (07/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 07/2025: removed (now) unused functions that were moved to timescale
     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
@@ -51,17 +52,13 @@ import re
 import io
 import ssl
 import json
-import netrc
 import ftplib
 import shutil
-import base64
 import socket
-import getpass
 import inspect
 import hashlib
 import logging
 import pathlib
-import builtins
 import warnings
 import importlib
 import posixpath
@@ -88,11 +85,8 @@ __all__ = [
     "url_split",
     "convert_arg_line_to_args",
     "build_logger",
-    "roman_to_int",
     "get_unix_time",
-    "isoformat",
     "even",
-    "ceil",
     "copy",
     "check_ftp_connection",
     "ftp_list",
@@ -104,14 +98,6 @@ __all__ = [
     "http_list",
     "from_http",
     "from_json",
-    "attempt_login",
-    "build_opener",
-    "get_token",
-    "list_tokens",
-    "revoke_token",
-    "check_credentials",
-    "cddis_list",
-    "from_cddis",
     "iers_list",
     "from_jpl_ssd",
     "uhslc_list"
@@ -358,30 +344,6 @@ def build_logger(name: str, **kwargs):
         logger.addHandler(handler)
     return logger
 
-# PURPOSE: convert Roman numerals to (Arabic) integers
-def roman_to_int(roman: str):
-    """
-    Converts a string from Roman numerals into an integer (Arabic)
-
-    Parameters
-    ----------
-    roman: str
-        Roman numeral string
-    """
-    # mapping between Roman and Arabic numerals
-    roman_map = {'i':1, 'v':5, 'x':10, 'l':50, 'c':100, 'd':500, 'm':1000}
-    # verify case
-    roman = roman.lower()
-    output = 0
-    # iterate through roman numerals in string and calculate total
-    for i,s in enumerate(roman):
-        if (i > 0) and (roman_map[s] > roman_map[roman[i-1]]):
-            output += roman_map[s] - 2*roman_map[roman[i-1]]
-        else:
-            output += roman_map[s]
-    # return the integer value
-    return output
-
 # PURPOSE: returns the Unix timestamp value for a formatted date string
 def get_unix_time(
         time_string: str,
@@ -411,24 +373,6 @@ def get_unix_time(
     else:
         return parsed_time.timestamp()
 
-# PURPOSE: output a time string in isoformat
-def isoformat(time_string: str):
-    """
-    Reformat a date string to ISO formatting
-
-    Parameters
-    ----------
-    time_string: str
-        formatted time string to parse
-    """
-    # try parsing with dateutil
-    try:
-        parsed_time = dateutil.parser.parse(time_string.rstrip())
-    except (TypeError, ValueError):
-        return None
-    else:
-        return parsed_time.isoformat()
-
 # PURPOSE: rounds a number to an even number less than or equal to original
 def even(value: float):
     """
@@ -441,18 +385,6 @@ def even(value: float):
     """
     return 2*int(value//2)
 
-# PURPOSE: rounds a number upward to its nearest integer
-def ceil(value: float):
-    """
-    Rounds a number upward to its nearest integer
-
-    Parameters
-    ----------
-    value: float
-        number to be rounded upward
-    """
-    return -int(-value//1)
-
 # PURPOSE: make a copy of a file with all system information
 def copy(
         source: str | pathlib.Path,
@@ -940,534 +872,6 @@ def from_json(
         # load JSON response
         return json.loads(response.read())
 
-# PURPOSE: attempt to build an opener with netrc
-def attempt_login(
-        urs: str,
-        context=_default_ssl_context,
-        password_manager: bool = True,
-        get_ca_certs: bool = True,
-        redirect: bool = True,
-        authorization_header: bool = False,
-        **kwargs
-    ):
-    """
-    attempt to build a urllib opener for NASA Earthdata
-
-    Parameters
-    ----------
-    urs: str
-        Earthdata login URS 3 host
-    context: obj, default pyTMD.utilities._default_ssl_context
-        SSL context for ``urllib`` opener object
-    password_manager: bool, default True
-        Create password manager context using default realm
-    get_ca_certs: bool, default True
-        Get list of loaded “certification authority” certificates
-    redirect: bool, default True
-        Create redirect handler object
-    authorization_header: bool, default False
-        Add base64 encoded authorization header to opener
-    username: str, default from environmental variable
-        NASA Earthdata username
-    password: str, default from environmental variable
-        NASA Earthdata password
-    retries: int, default 5
-        number of retry attempts
-    netrc: str, default ~/.netrc
-        path to .netrc file for authentication
-
-    Returns
-    -------
-    opener: obj
-        OpenerDirector instance
-    """
-    # set default keyword arguments
-    kwargs.setdefault('username', os.environ.get('EARTHDATA_USERNAME'))
-    kwargs.setdefault('password', os.environ.get('EARTHDATA_PASSWORD'))
-    kwargs.setdefault('retries', 5)
-    kwargs.setdefault('netrc', os.path.expanduser('~/.netrc'))
-    try:
-        # only necessary on jupyterhub
-        os.chmod(kwargs['netrc'], 0o600)
-        # try retrieving credentials from netrc
-        username, _, password = netrc.netrc(kwargs['netrc']).authenticators(urs)
-    except Exception as exc:
-        # try retrieving credentials from environmental variables
-        username, password = (kwargs['username'], kwargs['password'])
-        pass
-    # if username or password are not available
-    if not username:
-        username = builtins.input(f'Username for {urs}: ')
-    if not password:
-        prompt = f'Password for {username}@{urs}: '
-        password = getpass.getpass(prompt=prompt)
-    # for each retry
-    for retry in range(kwargs['retries']):
-        # build an opener for urs with credentials
-        opener = build_opener(username, password,
-            context=context,
-            password_manager=password_manager,
-            get_ca_certs=get_ca_certs,
-            redirect=redirect,
-            authorization_header=authorization_header,
-            urs=urs)
-        # try logging in by check credentials
-        try:
-            check_credentials()
-        except Exception as exc:
-            pass
-        else:
-            return opener
-        # reattempt login
-        username = builtins.input(f'Username for {urs}: ')
-        password = getpass.getpass(prompt=prompt)
-    # reached end of available retries
-    raise RuntimeError('End of Retries: Check NASA Earthdata credentials')
-
-# PURPOSE: "login" to NASA Earthdata with supplied credentials
-def build_opener(
-        username: str,
-        password: str,
-        context=_default_ssl_context,
-        password_manager: bool = True,
-        get_ca_certs: bool = True,
-        redirect: bool = True,
-        authorization_header: bool = False,
-        urs: str = 'https://urs.earthdata.nasa.gov'
-    ):
-    """
-    Build ``urllib`` opener for NASA Earthdata with supplied credentials
-
-    Parameters
-    ----------
-    username: str or NoneType, default None
-        NASA Earthdata username
-    password: str or NoneType, default None
-        NASA Earthdata password
-    context: obj, default pyTMD.utilities._default_ssl_context
-        SSL context for ``urllib`` opener object
-    password_manager: bool, default True
-        Create password manager context using default realm
-    get_ca_certs: bool, default True
-        Get list of loaded “certification authority” certificates
-    redirect: bool, default True
-        Create redirect handler object
-    authorization_header: bool, default False
-        Add base64 encoded authorization header to opener
-    urs: str, default 'https://urs.earthdata.nasa.gov'
-        Earthdata login URS 3 host
-
-    Returns
-    -------
-    opener: obj
-        ``OpenerDirector`` instance
-    """
-    # https://docs.python.org/3/howto/urllib2.html#id5
-    handler = []
-    # create a password manager
-    if password_manager:
-        password_mgr = urllib2.HTTPPasswordMgrWithDefaultRealm()
-        # Add the username and password for NASA Earthdata Login system
-        password_mgr.add_password(None, urs, username, password)
-        handler.append(urllib2.HTTPBasicAuthHandler(password_mgr))
-    # Create cookie jar for storing cookies. This is used to store and return
-    # the session cookie given to use by the data server (otherwise will just
-    # keep sending us back to Earthdata Login to authenticate).
-    cookie_jar = CookieJar()
-    handler.append(urllib2.HTTPCookieProcessor(cookie_jar))
-    # SSL context handler
-    if get_ca_certs:
-        context.get_ca_certs()
-    handler.append(urllib2.HTTPSHandler(context=context))
-    # redirect handler
-    if redirect:
-        handler.append(urllib2.HTTPRedirectHandler())
-    # create "opener" (OpenerDirector instance)
-    opener = urllib2.build_opener(*handler)
-    # Encode username/password for request authorization headers
-    # add Authorization header to opener
-    if authorization_header:
-        b64 = base64.b64encode(f'{username}:{password}'.encode())
-        opener.addheaders = [("Authorization", f"Basic {b64.decode()}")]
-    # Now all calls to urllib2.urlopen use our opener.
-    urllib2.install_opener(opener)
-    # All calls to urllib2.urlopen will now use handler
-    # Make sure not to include the protocol in with the URL, or
-    # HTTPPasswordMgrWithDefaultRealm will be confused.
-    return opener
-
-# PURPOSE: generate a NASA Earthdata user token
-def get_token(
-        HOST: str = 'https://urs.earthdata.nasa.gov/api/users/token',
-        username: str | None = None,
-        password: str | None = None,
-        build: bool = True,
-        urs: str = 'urs.earthdata.nasa.gov',
-    ):
-    """
-    Generate a NASA Earthdata User Token
-
-    Parameters
-    ----------
-    HOST: str or list
-        NASA Earthdata token API host
-    username: str or NoneType, default None
-        NASA Earthdata username
-    password: str or NoneType, default None
-        NASA Earthdata password
-    build: bool, default True
-        Build opener and check WebDAV credentials
-    timeout: int or NoneType, default None
-        timeout in seconds for blocking operations
-    urs: str, default 'urs.earthdata.nasa.gov'
-        NASA Earthdata URS 3 host
-
-    Returns
-    -------
-    token: dict
-        JSON response with NASA Earthdata User Token
-    """
-    # attempt to build urllib2 opener and check credentials
-    if build:
-        attempt_login(urs,
-            username=username,
-            password=password,
-            password_manager=False,
-            get_ca_certs=False,
-            redirect=False,
-            authorization_header=True)
-    # create post response with Earthdata token API
-    try:
-        request = urllib2.Request(HOST, method='POST')
-        response = urllib2.urlopen(request)
-    except urllib2.HTTPError as exc:
-        logging.debug(exc.code)
-        raise RuntimeError(exc.reason) from exc
-    except urllib2.URLError as exc:
-        logging.debug(exc.reason)
-        raise RuntimeError('Check internet connection') from exc
-    # read and return JSON response
-    return json.loads(response.read())
-
-# PURPOSE: generate a NASA Earthdata user token
-def list_tokens(
-        HOST: str = 'https://urs.earthdata.nasa.gov/api/users/tokens',
-        username: str | None = None,
-        password: str | None = None,
-        build: bool = True,
-        urs: str = 'urs.earthdata.nasa.gov',
-    ):
-    """
-    List the current associated NASA Earthdata User Tokens
-
-    Parameters
-    ----------
-    HOST: str
-        NASA Earthdata list token API host
-    username: str or NoneType, default None
-        NASA Earthdata username
-    password: str or NoneType, default None
-        NASA Earthdata password
-    build: bool, default True
-        Build opener and check WebDAV credentials
-    timeout: int or NoneType, default None
-        timeout in seconds for blocking operations
-    urs: str, default 'urs.earthdata.nasa.gov'
-        NASA Earthdata URS 3 host
-
-    Returns
-    -------
-    tokens: list
-        JSON response with NASA Earthdata User Tokens
-    """
-    # attempt to build urllib2 opener and check credentials
-    if build:
-        attempt_login(urs,
-            username=username,
-            password=password,
-            password_manager=False,
-            get_ca_certs=False,
-            redirect=False,
-            authorization_header=True)
-    # create get response with Earthdata list tokens API
-    try:
-        request = urllib2.Request(HOST)
-        response = urllib2.urlopen(request)
-    except urllib2.HTTPError as exc:
-        logging.debug(exc.code)
-        raise RuntimeError(exc.reason) from exc
-    except urllib2.URLError as exc:
-        logging.debug(exc.reason)
-        raise RuntimeError('Check internet connection') from exc
-    # read and return JSON response
-    return json.loads(response.read())
-
-# PURPOSE: revoke a NASA Earthdata user token
-def revoke_token(
-        token: str,
-        HOST: str = f'https://urs.earthdata.nasa.gov/api/users/revoke_token',
-        username: str | None = None,
-        password: str | None = None,
-        build: bool = True,
-        urs: str = 'urs.earthdata.nasa.gov',
-    ):
-    """
-    Generate a NASA Earthdata User Token
-
-    Parameters
-    ----------
-    token: str
-        NASA Earthdata token to be revoked
-    HOST: str
-        NASA Earthdata revoke token API host
-    username: str or NoneType, default None
-        NASA Earthdata username
-    password: str or NoneType, default None
-        NASA Earthdata password
-    build: bool, default True
-        Build opener and check WebDAV credentials
-    timeout: int or NoneType, default None
-        timeout in seconds for blocking operations
-    urs: str, default 'urs.earthdata.nasa.gov'
-        NASA Earthdata URS 3 host
-    """
-    # attempt to build urllib2 opener and check credentials
-    if build:
-        attempt_login(urs,
-            username=username,
-            password=password,
-            password_manager=False,
-            get_ca_certs=False,
-            redirect=False,
-            authorization_header=True)
-    # full path for NASA Earthdata revoke token API
-    url = f'{HOST}?token={token}'
-    # create post response with Earthdata revoke tokens API
-    try:
-        request = urllib2.Request(url, method='POST')
-        response = urllib2.urlopen(request)
-    except urllib2.HTTPError as exc:
-        logging.debug(exc.code)
-        raise RuntimeError(exc.reason) from exc
-    except urllib2.URLError as exc:
-        logging.debug(exc.reason)
-        raise RuntimeError('Check internet connection') from exc
-    # verbose response
-    logging.debug(f'Token Revoked: {token}')
-
-# PURPOSE: check that entered NASA Earthdata credentials are valid
-def check_credentials():
-    """
-    Check that entered NASA Earthdata credentials are valid
-    """
-    try:
-        remote_path = posixpath.join('https://cddis.nasa.gov','archive')
-        request = urllib2.Request(url=remote_path)
-        response = urllib2.urlopen(request, timeout=20)
-    except urllib2.HTTPError as exc:
-        logging.debug(exc.code)
-        raise RuntimeError(exc.reason) from exc
-    except urllib2.URLError as exc:
-        logging.debug(exc.reason)
-        raise RuntimeError('Check internet connection') from exc
-    else:
-        return True
-
-# PURPOSE: list a directory on GSFC CDDIS https server
-def cddis_list(
-        HOST: str | list,
-        username: str | None = None,
-        password: str | None = None,
-        build: bool = True,
-        timeout: int | None = None,
-        urs: str = 'urs.earthdata.nasa.gov',
-        parser=lxml.etree.HTMLParser(),
-        pattern: str = '',
-        sort: bool = False
-    ):
-    """
-    List a directory on GSFC CDDIS archive server
-
-    Parameters
-    ----------
-    HOST: str or list
-        remote https host
-    username: str or NoneType, default None
-        NASA Earthdata username
-    password: str or NoneType, default None
-        NASA Earthdata password
-    build: bool, default True
-        Build opener and check Earthdata credentials
-    timeout: int or NoneType, default None
-        timeout in seconds for blocking operations
-    urs: str, default 'urs.earthdata.nasa.gov'
-        NASA Earthdata URS 3 host
-    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
-    collastmod: list
-        last modification times for items in the directory
-    """
-    # use netrc credentials
-    if build and not (username or password):
-        username,_,password = netrc.netrc().authenticators(urs)
-    # build urllib2 opener and check credentials
-    if build:
-        # build urllib2 opener with credentials
-        build_opener(username, password)
-        # check credentials
-        check_credentials()
-    # verify inputs for remote https host
-    if isinstance(HOST, str):
-        HOST = url_split(HOST)
-    # Encode username/password for request authorization headers
-    b64 = base64.b64encode(f'{username}:{password}'.encode())
-    authorization_header = f"Basic {b64.decode()}"
-    # try listing from https
-    try:
-        # Create and submit request.
-        request = urllib2.Request(posixpath.join(*HOST))
-        request.add_header("Authorization", authorization_header)
-        tree = lxml.etree.parse(urllib2.urlopen(request, timeout=timeout), parser)
-    except:
-        raise Exception('List error from {0}'.format(posixpath.join(*HOST)))
-    else:
-        # read and parse request for files (column names and modified times)
-        # find directories
-        colnames = tree.xpath('//div[@class="archiveDir"]/div/a/text()')
-        collastmod = [None]*(len(colnames))
-        # find files
-        colnames.extend(tree.xpath('//div[@class="archiveItem"]/div/a/text()'))
-        # get the Unix timestamp value for a modification time
-        collastmod.extend([get_unix_time(i[:19], format='%Y:%m:%d %H:%M:%S')
-            for i in tree.xpath('//div[@class="archiveItem"]/div/span/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 and last modified times
-            colnames = [colnames[indice] for indice in i]
-            collastmod = [collastmod[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 and last modified times
-            colnames = [colnames[indice] for indice in i]
-            collastmod = [collastmod[indice] for indice in i]
-        # return the list of column names and last modified times
-        return (colnames, collastmod)
-
-# PURPOSE: download a file from a GSFC CDDIS https server
-def from_cddis(
-        HOST: str | list,
-        username: str | None = None,
-        password: str | None = None,
-        build: bool = True,
-        timeout: int | None = None,
-        urs: str = 'urs.earthdata.nasa.gov',
-        local: str | pathlib.Path | None = None,
-        hash: str = '',
-        chunk: int = 16384,
-        verbose: bool = False,
-        fid=sys.stdout,
-        mode: oct = 0o775
-    ):
-    """
-    Download a file from GSFC CDDIS archive server
-
-    Parameters
-    ----------
-    HOST: str or list
-        remote https host
-    username: str or NoneType, default None
-        NASA Earthdata username
-    password: str or NoneType, default None
-        NASA Earthdata password
-    build: bool, default True
-        Build opener and check Earthdata credentials
-    timeout: int or NoneType, default None
-        timeout in seconds for blocking operations
-    urs: str, default 'urs.earthdata.nasa.gov'
-        NASA Earthdata URS 3 host
-    local: str, pathlib.Path or NoneType, default None
-        path to local file
-    hash: str, default ''
-        MD5 hash of local file
-    chunk: int, default 16384
-        chunk size for transfer encoding
-    verbose: bool, default False
-        print file transfer information
-    fid: obj, default sys.stdout
-        open file object to print if verbose
-    mode: oct, default 0o775
-        permissions mode of output local file
-
-    Returns
-    -------
-    remote_buffer: obj
-        BytesIO representation of file
-    """
-    # create logger
-    loglevel = logging.INFO if verbose else logging.CRITICAL
-    logging.basicConfig(stream=fid, level=loglevel)
-    # use netrc credentials
-    if build and not (username or password):
-        username,_,password = netrc.netrc().authenticators(urs)
-    # build urllib2 opener and check credentials
-    if build:
-        # build urllib2 opener with credentials
-        build_opener(username, password)
-        # check credentials
-        check_credentials()
-    # verify inputs for remote https host
-    if isinstance(HOST, str):
-        HOST = url_split(HOST)
-    # Encode username/password for request authorization headers
-    b64 = base64.b64encode(f'{username}:{password}'.encode())
-    authorization_header = f"Basic {b64.decode()}"
-    # try downloading from https
-    try:
-        # Create and submit request.
-        request = urllib2.Request(posixpath.join(*HOST))
-        request.add_header("Authorization", authorization_header)
-        response = urllib2.urlopen(request, timeout=timeout)
-    except:
-        raise Exception('Download error from {0}'.format(posixpath.join(*HOST)))
-    else:
-        # copy remote file contents to bytesIO object
-        remote_buffer = io.BytesIO()
-        shutil.copyfileobj(response, remote_buffer, chunk)
-        remote_buffer.seek(0)
-        # save file basename with bytesIO object
-        remote_buffer.filename = HOST[-1]
-        # generate checksum hash for remote file
-        remote_hash = hashlib.md5(remote_buffer.getvalue()).hexdigest()
-        # compare checksums
-        if local and (hash != remote_hash):
-            # convert to absolute path
-            local = pathlib.Path(local).expanduser().absolute()
-            # create directory if non-existent
-            local.parent.mkdir(mode=mode, parents=True, exist_ok=True)
-            # print file information
-            args = (posixpath.join(*HOST), str(local))
-            logging.info('{0} -->\n\t{1}'.format(*args))
-            # store bytes to file using chunked transfer encoding
-            remote_buffer.seek(0)
-            with local.open(mode='wb') as f:
-                shutil.copyfileobj(remote_buffer, f, chunk)
-            # change the permissions mode
-            local.chmod(mode)
-        # return the bytesIO object
-        remote_buffer.seek(0)
-        return remote_buffer
-
 # PURPOSE: list a directory on IERS https Server
 def iers_list(
         HOST: str | list,

{pytmd-2.2.5 → pytmd-2.2.6}/pyTMD.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyTMD
-Version: 2.2.5
+Version: 2.2.6
 Summary: Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides
 Author: Tyler Sutterley
 Author-email: tsutterl@uw.edu

{pytmd-2.2.5 → pytmd-2.2.6}/scripts/aviso_fes_tides.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 aviso_fes_tides.py
-Written by Tyler Sutterley (01/2025)
+Written by Tyler Sutterley (07/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/
@@ -24,9 +24,12 @@ COMMAND LINE OPTIONS:
         FES2012
         FES2014
         FES2022
-    --load: download load tide model outputs (FES2014)
-    --currents: download tide model current outputs (FES2012 and FES2014)
-    --extrapolated: Download extrapolated tide model outputs (FES2022)
+    --load: download load tide model outputs
+        (FES2014)
+    --currents: download tide model current outputs
+        (FES2012 and FES2014)
+    --extrapolated: Download extrapolated tide model outputs
+        (FES2014 and FES2022)
     -G, --gzip: compress output ascii and netCDF4 tide files
     -t X, --timeout X: timeout in seconds for blocking operations
     --log: output log of files downloaded
@@ -40,6 +43,7 @@ PROGRAM DEPENDENCIES:
     utilities.py: download and management utilities for syncing files
 
 UPDATE HISTORY:
+    Updated 07/2025: added extrapolation option for FES2014 tide model
     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
@@ -119,6 +123,7 @@ def aviso_fes_tides(MODEL: str,
             DIRECTORY=DIRECTORY,
             LOAD=LOAD,
             CURRENTS=CURRENTS,
+            EXTRAPOLATED=EXTRAPOLATED,
             GZIP=GZIP,
             MODE=MODE)
     elif MODEL in ('FES2022',):
@@ -142,6 +147,7 @@ def aviso_fes_tar(MODEL, f, logger,
         DIRECTORY: str | pathlib.Path | None = None,
         LOAD: bool = False,
         CURRENTS: bool = False,
+        EXTRAPOLATED: bool = False,
         GZIP: bool = False,
         MODE: oct = 0o775
     ):
@@ -201,6 +207,12 @@ def aviso_fes_tar(MODEL, f, logger,
             'fes2014a_loadtide','load_tide.tar.xz'])
         TAR['FES2014'].extend(['r'])
         FLATTEN['FES2014'].extend([False])
+    if EXTRAPOLATED:
+        FES['FES2014'].append(['fes2014_elevations_and_load',
+            'fes2014b_elevations_extrapolated',
+            'ocean_tide_extrapolated.tar.xz'])
+        TAR['FES2014'].extend(['r'])
+        FLATTEN['FES2014'].extend([False])
     if CURRENTS:
         subdir = 'fes2014a_currents'
         FES['FES2014'].append([subdir,'readme_fes2014_currents_v1.2.txt'])

{pytmd-2.2.5 → pytmd-2.2.6}/scripts/gsfc_got_tides.py

@@ -2,7 +2,7 @@
 u"""
 gsfc_got_tides.py
 Written by Tyler Sutterley (01/2025)
-Download GSFC Global Ocean Tide (GOT) models
+Download Goddard Ocean Tide (GOT) models
 
 CALLING SEQUENCE:
     python gsfc_got_tides.py --tide=GOT5.6
@@ -132,7 +132,7 @@ def newer(t1: int, t2: int) -> bool:
 # PURPOSE: create argument parser
 def arguments():
     parser = argparse.ArgumentParser(
-        description="""Download Global Ocean Tide models from NASA
+        description="""Download Goddard Tide models from NASA
             Goddard Space Flight Center (GSFC)
             """,
         fromfile_prefix_chars="@"
@@ -143,16 +143,16 @@ def arguments():
     parser.add_argument('--directory','-D',
         type=pathlib.Path, default=pathlib.Path.cwd(),
         help='Working data directory')
-    # Global Ocean Tide model to download
+    # Goddard Ocean Tide model to download
     parser.add_argument('--tide','-T',
         metavar='TIDE', type=str, nargs='+', default=['GOT5.5'],
         choices=('GOT4.8','GOT4.10','GOT5.5','GOT5.5D','GOT5.6','RE14'),
-        help='Global Ocean Tide model to download')
-    # Global Ocean Tide model format to download
+        help='Goddard Ocean Tide model to download')
+    # Goddard Ocean Tide model format to download
     parser.add_argument('--format',
         type=str, default='netcdf',
         choices=('ascii','netcdf'),
-        help='Global Ocean Tide model format to download')
+        help='Goddard Ocean Tide model format to download')
     # compress output ascii and netCDF4 tide files with gzip
     parser.add_argument('--gzip','-G',
         default=False, action='store_true',

pytmd-2.2.6/version.txt

@@ -0,0 +1 @@
+2.2.6

pytmd-2.2.5/version.txt

@@ -1 +0,0 @@
-2.2.5