pyTMD 2.2.1__tar.gz → 2.2.2__tar.gz

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

@@ -31,13 +31,13 @@ identifiers:
   - type: doi
     value: 10.5281/zenodo.5555395
     description: Zenodo Archive
-repository-code: 'https://github.com/tsutterley/pyTMD'
+repository-code: 'https://github.com/pyTMD/pyTMD'
 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.1"
-date-released: "2025-02-10"
+version: "2.2.2"
+date-released: "2025-02-19"
 keywords:
   - Ocean Tides
   - Load Tides

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pyTMD
-Version: 2.2.1
+Version: 2.2.2
 Summary: Python-based tidal prediction software for estimating ocean, load, solid Earth and pole tides
 Author: Tyler Sutterley
 Author-email: tsutterl@uw.edu
@@ -29,8 +29,8 @@ License: MIT License
         
 Project-URL: Homepage, https://pytmd.readthedocs.io
 Project-URL: Documentation, https://pytmd.readthedocs.io
-Project-URL: Repository, https://github.com/tsutterley/pyTMD
-Project-URL: Issues, https://github.com/tsutterley/pyTMD/issues
+Project-URL: Repository, https://github.com/pyTMD/pyTMD
+Project-URL: Issues, https://github.com/pyTMD/pyTMD/issues
 Keywords: Ocean Tides,Load Tides,Pole Tides,Solid Earth Tides,Tidal Prediction
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Science/Research
@@ -70,16 +70,12 @@ Requires-Dist: sphinx-design; extra == "doc"
 Requires-Dist: sphinx_rtd_theme; extra == "doc"
 Provides-Extra: all
 Requires-Dist: cartopy; extra == "all"
-Requires-Dist: gdal; extra == "all"
-Requires-Dist: h5py; extra == "all"
 Requires-Dist: ipyleaflet; extra == "all"
 Requires-Dist: ipywidgets; extra == "all"
 Requires-Dist: jplephem; extra == "all"
 Requires-Dist: matplotlib; extra == "all"
-Requires-Dist: mpi4py; extra == "all"
 Requires-Dist: notebook; extra == "all"
 Requires-Dist: pandas; extra == "all"
-Requires-Dist: pyyaml; extra == "all"
 Provides-Extra: dev
 Requires-Dist: flake8; extra == "dev"
 Requires-Dist: pytest>=4.6; extra == "dev"
@@ -93,26 +89,26 @@ pyTMD
 
 |License|
 |Documentation Status|
-|Coverage Status|
 |PyPI|
 |conda-forge|
+|commits-since|
 |zenodo|
 
-.. |License| image:: https://img.shields.io/github/license/tsutterley/pyTMD
-   :target: https://github.com/tsutterley/pyTMD/blob/main/LICENSE
+.. |License| image:: https://img.shields.io/github/license/pyTMD/pyTMD
+   :target: https://github.com/pyTMD/pyTMD/blob/main/LICENSE
 
 .. |Documentation Status| image:: https://readthedocs.org/projects/pytmd/badge/?version=latest
    :target: https://pytmd.readthedocs.io/en/latest/?badge=latest
 
-.. |Coverage Status| image:: https://codecov.io/gh/tsutterley/pyTMD/branch/main/graph/badge.svg
-   :target: https://codecov.io/gh/tsutterley/pyTMD
-
 .. |PyPI| image:: https://img.shields.io/pypi/v/pyTMD.svg
    :target: https://pypi.python.org/pypi/pyTMD/
 
 .. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pytmd
    :target: https://anaconda.org/conda-forge/pytmd
 
+.. |commits-since| image:: https://img.shields.io/github/commits-since/pyTMD/pyTMD/latest
+   :target: https://github.com/pyTMD/pyTMD/releases
+
 .. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5555395.svg
    :target: https://doi.org/10.5281/zenodo.5555395
 
@@ -149,7 +145,7 @@ Development version from GitHub:
 
 .. code-block:: bash
 
-   python3 -m pip install git+https://github.com/tsutterley/pyTMD.git
+   python3 -m pip install git+https://github.com/pyTMD/pyTMD.git
 
 Dependencies
 ############
@@ -178,9 +174,9 @@ Download
 ########
 
 | The program homepage is:
-| https://github.com/tsutterley/pyTMD
+| https://github.com/pyTMD/pyTMD
 | A zip archive of the latest version is available directly at:
-| https://github.com/tsutterley/pyTMD/archive/main.zip
+| https://github.com/pyTMD/pyTMD/archive/main.zip
 
 Alternative Software
 ####################
@@ -204,7 +200,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 `discussions board <https://github.com/tsutterley/pyTMD/discussions>`_.
+If you would like to contribute to the project, please have a look at the `open issues <https://github.com/pyTMD/pyTMD/issues>`_ and `discussions board <https://github.com/pyTMD/pyTMD/discussions>`_.
 
 Credits
 #######

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

@@ -4,26 +4,26 @@ pyTMD
 
 |License|
 |Documentation Status|
-|Coverage Status|
 |PyPI|
 |conda-forge|
+|commits-since|
 |zenodo|
 
-.. |License| image:: https://img.shields.io/github/license/tsutterley/pyTMD
-   :target: https://github.com/tsutterley/pyTMD/blob/main/LICENSE
+.. |License| image:: https://img.shields.io/github/license/pyTMD/pyTMD
+   :target: https://github.com/pyTMD/pyTMD/blob/main/LICENSE
 
 .. |Documentation Status| image:: https://readthedocs.org/projects/pytmd/badge/?version=latest
    :target: https://pytmd.readthedocs.io/en/latest/?badge=latest
 
-.. |Coverage Status| image:: https://codecov.io/gh/tsutterley/pyTMD/branch/main/graph/badge.svg
-   :target: https://codecov.io/gh/tsutterley/pyTMD
-
 .. |PyPI| image:: https://img.shields.io/pypi/v/pyTMD.svg
    :target: https://pypi.python.org/pypi/pyTMD/
 
 .. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pytmd
    :target: https://anaconda.org/conda-forge/pytmd
 
+.. |commits-since| image:: https://img.shields.io/github/commits-since/pyTMD/pyTMD/latest
+   :target: https://github.com/pyTMD/pyTMD/releases
+
 .. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5555395.svg
    :target: https://doi.org/10.5281/zenodo.5555395
 
@@ -60,7 +60,7 @@ Development version from GitHub:
 
 .. code-block:: bash
 
-   python3 -m pip install git+https://github.com/tsutterley/pyTMD.git
+   python3 -m pip install git+https://github.com/pyTMD/pyTMD.git
 
 Dependencies
 ############
@@ -89,9 +89,9 @@ Download
 ########
 
 | The program homepage is:
-| https://github.com/tsutterley/pyTMD
+| https://github.com/pyTMD/pyTMD
 | A zip archive of the latest version is available directly at:
-| https://github.com/tsutterley/pyTMD/archive/main.zip
+| https://github.com/pyTMD/pyTMD/archive/main.zip
 
 Alternative Software
 ####################
@@ -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 `discussions board <https://github.com/tsutterley/pyTMD/discussions>`_.
+If you would like to contribute to the project, please have a look at the `open issues <https://github.com/pyTMD/pyTMD/issues>`_ and `discussions board <https://github.com/pyTMD/pyTMD/discussions>`_.
 
 Credits
 #######

{pytmd-2.2.1 → pytmd-2.2.2}/pyTMD/__init__.py

@@ -24,14 +24,9 @@ import pyTMD.utilities
 import pyTMD.version
 from pyTMD import io
 from pyTMD import solve
-from pyTMD.crs import (
-    crs,
-    datum,
-    _ellipsoids
-)
+from pyTMD.crs import crs
 
 # Deprecated functions
-from pyTMD.check_points import check_points
 from pyTMD.compute_tide_corrections import (
     compute_corrections,
     compute_tide_corrections,
@@ -40,8 +35,6 @@ from pyTMD.compute_tide_corrections import (
     compute_OPT_corrections,
     compute_SET_corrections,
 )
-import pyTMD.eop
-import pyTMD.time
 
 # get semantic version from setuptools-scm
 __version__ = pyTMD.version.version

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

@@ -40,6 +40,8 @@ REFERENCES:
 
 UPDATE HISTORY:
     Updated 02/2025: add option to make doodson numbers strings
+        add Doodson number convention for converting 11 to E
+        add Doodson (1921) table for coefficients missing from Cartwright tables
     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
@@ -1489,6 +1491,8 @@ def _love_numbers(
     # return the Love numbers for frequency
     return (h2, k2, l2)
 
+# Doodson (1921) table with values missing from Cartwright tables
+_d1921_table = get_data_path(['data','d1921_tab.txt'])
 # Cartwright and Tayler (1971) table with 3rd-degree values
 _ct1971_table_5 = get_data_path(['data','ct1971_tab5.txt'])
 # Cartwright and Edden (1973) table with updated values
@@ -1561,13 +1565,14 @@ def _to_doodson_number(coef: list | np.ndarray, **kwargs):
     # add 5 to values following Doodson convention (prevent negatives)
     coef[1:] += 5
     # check for unsupported constituents
-    if (np.any(coef < 0) or np.any(coef > 10)) and kwargs['raise_error']:
+    if (np.any(coef < 0) or np.any(coef > 11)) and kwargs['raise_error']:
         raise ValueError('Unsupported constituent')
-    elif (np.any(coef < 0) or np.any(coef > 10)):
+    elif (np.any(coef < 0) or np.any(coef > 11)):
         return None
-    elif np.any(coef == 10):
-        # convert to string and replace 10 with X (Cartwright convention)
-        DO = [str(v).replace('10','X') for v in coef]
+    elif np.any(coef == 10) or np.any(coef == 11):
+        # convert coefficients to strings
+        # replace 10 with X and 11 with E (Doodson convention)
+        DO = [str(v).replace('10','X').replace('11','E') for v in coef]
         # convert to Doodson number
         return np.str_('{0}{1}{2}.{3}{4}{5}'.format(*DO))
     else:
@@ -1614,8 +1619,9 @@ def _from_doodson_number(DO: str | float | np.ndarray, **kwargs):
         Doodson coefficients (Cartwright numbers) for constituent
     """
     # convert from Doodson number to Cartwright numbers
-    coef = [c.replace('X', '10') for c in re.findall(r'\w', str(DO).zfill(7))]
-    coef = np.array(coef, dtype=int)
+    # replace 10 with X and 11 with E (Doodson convention)
+    coef = np.array([c.replace('X', '10').replace('E', '11')
+        for c in re.findall(r'\w', str(DO).zfill(7))], dtype=int)
     # remove 5 from values following Doodson convention
     coef[1:] -= 5
     return coef

{pytmd-2.2.1 → pytmd-2.2.2}/pyTMD/astro.py

@@ -8,8 +8,8 @@ PYTHON DEPENDENCIES:
     numpy: Scientific Computing Tools For Python
         https://numpy.org
         https://numpy.org/doc/stable/user/numpy-for-matlab-users.html
-    PyEphem: Astronomical Ephemeris for Python
-        https://rhodesmill.org/pyephem/
+    jplephem: Astronomical Ephemeris for Python
+        https://pypi.org/project/jplephem/
 
 REFERENCES:
     Jean Meeus, Astronomical Algorithms, 2nd edition, 1998.

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

@@ -960,7 +960,7 @@ def LPT_displacements(
 
     # validate input arguments
     assert TIME.lower() in ('gps', 'loran', 'tai', 'utc', 'datetime')
-    assert ELLIPSOID.upper() in pyTMD._ellipsoids
+    assert ELLIPSOID.upper() in pyTMD.spatial._ellipsoids
     assert CONVENTION.isdigit() and CONVENTION in timescale.eop._conventions
     # determine input data type based on variable dimensions
     if not TYPE:
@@ -999,7 +999,7 @@ def LPT_displacements(
     # degrees to radians
     dtr = np.pi/180.0
     # earth and physical parameters for ellipsoid
-    units = pyTMD.datum(ellipsoid=ELLIPSOID, units='MKS')
+    units = pyTMD.spatial.datum(ellipsoid=ELLIPSOID, units='MKS')
     # tidal love/shida numbers appropriate for the load tide
     hb2 = 0.6207
     lb2 = 0.0836
@@ -1167,7 +1167,7 @@ def OPT_displacements(
 
     # validate input arguments
     assert TIME.lower() in ('gps', 'loran', 'tai', 'utc', 'datetime')
-    assert ELLIPSOID.upper() in pyTMD._ellipsoids
+    assert ELLIPSOID.upper() in pyTMD.spatial._ellipsoids
     assert CONVENTION.isdigit() and CONVENTION in timescale.eop._conventions
     assert METHOD.lower() in ('bilinear', 'spline', 'linear', 'nearest')
     # determine input data type based on variable dimensions
@@ -1214,7 +1214,7 @@ def OPT_displacements(
     # degrees to radians
     dtr = np.pi/180.0
     # earth and physical parameters for ellipsoid
-    units = pyTMD.datum(ellipsoid=ELLIPSOID, units='MKS')
+    units = pyTMD.spatial.datum(ellipsoid=ELLIPSOID, units='MKS')
     # mean equatorial gravitational acceleration [m/s^2]
     ge = 9.7803278
     # density of sea water [kg/m^3]
@@ -1427,7 +1427,7 @@ def SET_displacements(
     nt = len(ts)
 
     # earth and physical parameters for ellipsoid
-    units = pyTMD.datum(ellipsoid=ELLIPSOID, units='MKS')
+    units = pyTMD.spatial.datum(ellipsoid=ELLIPSOID, units='MKS')
 
     # convert input coordinates to cartesian
     X, Y, Z = pyTMD.spatial.to_cartesian(lon, lat,

pytmd-2.2.2/pyTMD/crs.py

@@ -0,0 +1,247 @@
+#!/usr/bin/env python
+u"""
+crs.py
+Written by Tyler Sutterley (09/2024)
+Coordinates Reference System (CRS) class
+
+CALLING SEQUENCE:
+    x, y = pyTMD.crs().convert(lon, lat, PROJ, 'F')
+    lon, lat = pyTMD.crs().convert(x, y, PROJ, 'B')
+
+INPUTS:
+    i1: longitude ('F') or projection easting x ('B')
+    i2: latitude ('F') or projection northing y ('B')
+    PROJ: spatial reference system for coordinate transformations
+    BF: backwards ('B') or forward ('F') translations
+
+OPTIONS:
+    EPSG: spatial reference system code for input (F) and output (B) coordinates
+
+OUTPUTS:
+    o1: projection easting x ('F') or longitude ('B')
+    o2: projection northing y ('F') or latitude ('B')
+
+PYTHON DEPENDENCIES:
+    numpy: Scientific Computing Tools For Python
+        https://numpy.org
+        https://numpy.org/doc/stable/user/numpy-for-matlab-users.html
+    pyproj: Python interface to PROJ library
+        https://pypi.org/project/pyproj/
+        https://pyproj4.github.io/pyproj/
+
+UPDATE HISTORY:
+    Updated 09/2024: added function for idealized Arctic Azimuthal projection
+        complete refactor to use JSON dictionary format for model projections
+    Updated 07/2024: added function to get the CRS transform
+    Updated 05/2024: make subscriptable and allow item assignment
+    Updated 04/2024: use wrapper to importlib for optional dependencies
+    Updated 02/2024: changed class name for ellipsoid parameters to datum
+    Updated 12/2023: converted conversion functions to class
+    Updated 03/2023: add basic variable typing to function inputs
+        renamed coordinate reference system conversion functions
+    Updated 02/2023: use named exception before passing to custom
+    Updated 11/2022: place some imports within try/except statements
+        use f-strings for formatting verbose or ascii output
+    Updated 04/2022: updated docstrings to numpy documentation format
+    Updated 09/2021: added function for using custom projections
+    Updated 06/2021: added 3413 for new 1km Greenland model from ESR
+    Updated 08/2020: using conversion protocols following pyproj-2 updates
+        https://pyproj4.github.io/pyproj/stable/gotchas.html
+    Updated 07/2020: added function docstrings. changed function name
+    Updated 03/2020: remove commented coordinate conversion functions
+    Updated 11/2019: using pyproj for coordinate conversions
+    Written 09/2017
+"""
+
+from __future__ import annotations
+
+import logging
+import numpy as np
+from pyTMD.utilities import import_dependency
+# attempt imports
+pyproj = import_dependency('pyproj')
+
+__all__ = [
+    'crs',
+]
+
+class crs:
+    """Coordinate Reference System transformations for tide models
+
+    Attributes
+    ----------
+    name: str
+        Projection name
+    transformer: obj
+        ``pyproj`` transformer for changing coordinate reference system
+    """
+    def __init__(self):
+        self.name = None
+        self.transformer = None
+        self._direction = None
+
+    def convert(self,
+            i1: np.ndarray,
+            i2: np.ndarray,
+            PROJ: str | dict,
+            BF: str,
+            EPSG: int | str = 4326
+        ):
+        """
+        Converts points to and from Coordinates Reference Systems (CRS)
+
+        Parameters
+        ----------
+        i1: np.ndarray
+            Input x-coordinates
+        i2: np.ndarray
+            Input y-coordinates
+        PROJ: str or dict
+            Spatial reference system for coordinate transformations
+        BF: str
+            Direction of transformation
+
+                - ``'B'``: backwards
+                - ``'F'``: forwards
+        EPSG: int or str, default 4326 (WGS84 Latitude/Longitude)
+            input (``'F'``) or output (``'B'``) coordinate system
+
+        Returns
+        -------
+        o1: np.ndarray
+            Output transformed x-coordinates
+        o2: np.ndarray
+            Output transformed y-coordinates
+        """
+        # name of the projection
+        self.name = PROJ
+        # get the CRS and transform direction
+        self.get(PROJ)
+        self._direction = BF[0].upper()
+        # run conversion program and return values
+        return self.transform(i1, i2, EPSG=EPSG)
+
+    # PURPOSE: try to get the projection information
+    def get(self, PROJ: str | dict):
+        """
+        Tries to get the coordinate reference system
+
+        Parameters
+        ----------
+        PROJ: str or dict
+            Spatial reference system for coordinate transformations
+        """
+        # get the coordinate reference system
+        try:
+            self.crs = self.from_input(PROJ)
+            self.name = self.crs.name
+        except Exception as exc:
+            pass
+        else:
+            return self
+        # projection not found or available
+        raise pyproj.exceptions.CRSError
+
+    def transform(self,
+            i1: np.ndarray,
+            i2: np.ndarray,
+            EPSG: int | str = 4326,
+            **kwargs):
+        """
+        Performs Coordinates Reference System (CRS) transformations
+
+        Parameters
+        ----------
+        i1: np.ndarray
+            Input x-coordinates
+        i2: np.ndarray
+            Input y-coordinates
+        EPSG: int or str, default 4326 (WGS84 Latitude/Longitude)
+            input (``'F'``) or output (``'B'``) coordinate system
+        kwargs: dict
+            Keyword arguments for the transformation
+
+        Returns
+        -------
+        o1: np.ndarray
+            Output transformed x-coordinates
+        o2: np.ndarray
+            Output transformed y-coordinates
+        """
+        # set the direction of the transformation
+        kwargs.setdefault('direction', self.direction)
+        # get the coordinate reference system and transform
+        source_crs = self.from_input(EPSG)
+        self.transformer = pyproj.Transformer.from_crs(
+            source_crs, self.crs, always_xy=True)
+        # convert coordinate reference system
+        o1, o2 = self.transformer.transform(i1, i2, **kwargs)
+        # return the transformed coordinates
+        return (o1, o2)
+
+    # PURPOSE: try to get the projection information
+    def from_input(self, PROJECTION: int | str | dict):
+        """
+        Attempt to retrieve the Coordinate Reference System
+
+        Parameters
+        ----------
+        PROJECTION: int, str or dict
+            Coordinate Reference System
+        """
+        # coordinate reference system dictoinary
+        try:
+            CRS = pyproj.CRS.from_user_input(PROJECTION)
+        except (ValueError, pyproj.exceptions.CRSError):
+            pass
+        else:
+            return CRS
+        # EPSG projection code
+        try:
+            CRS = pyproj.CRS.from_epsg(int(PROJECTION))
+        except (ValueError, pyproj.exceptions.CRSError):
+            pass
+        else:
+            return CRS
+        # coordinate reference system string
+        try:
+            CRS = pyproj.CRS.from_string(PROJECTION)
+        except (ValueError, pyproj.exceptions.CRSError):
+            pass
+        else:
+            return CRS
+        # no projection can be made
+        raise pyproj.exceptions.CRSError
+
+    @property
+    def direction(self):
+        """
+        ``pyproj`` direction of the coordinate transform
+        """
+        # convert from input coordinates to model coordinates
+        if (self._direction is None) or (self._direction.upper() == 'F'):
+            return pyproj.enums.TransformDirection.FORWARD
+        # convert from model coordinates to coordinates
+        elif (self._direction.upper() == 'B'):
+            return pyproj.enums.TransformDirection.INVERSE
+
+    @property
+    def is_geographic(self):
+        """
+        Check if the coordinate reference system is geographic
+        """
+        return self.crs.is_geographic
+
+    def __str__(self):
+        """String representation of the ``crs`` object
+        """
+        properties = ['pyTMD.crs']
+        properties.append(f"    name: {self.name}")
+        properties.append(f"    direction: {self.direction.name}")
+        return '\n'.join(properties)
+
+    def __getitem__(self, key):
+        return getattr(self, key)
+
+    def __setitem__(self, key, value):
+        setattr(self, key, value)

pytmd-2.2.2/pyTMD/data/d1921_tab.txt

@@ -0,0 +1,21 @@
+0  5 -4  1  0  0 -0.00010 -0.00010 -0.00010  0X1.655  0.00023
+0  5 -2 -1  0  0 -0.00049 -0.00049 -0.00049  0X3.455  0.00116
+0  5 -2 -1  1  0 -0.00020 -0.00020 -0.00020  0X3.465  0.00048
+0  5  0 -3  0  0 -0.00019 -0.00019 -0.00019  0X5.255  0.00045
+0  5  0 -3  1  0 -0.00008 -0.00008 -0.00008  0X5.265  0.00019
+0  6 -4  0  0  0 -0.00005 -0.00005 -0.00005  0E1.555  0.00012
+0  6 -2  0  0  0 -0.00008 -0.00008 -0.00008  0E3.555  0.00019
+1 -5  0  4  0  0 -0.00008 -0.00008 -0.00008  105.955  0.00011
+1 -5  2  2  0  0 -0.00032 -0.00032 -0.00032  107.755  0.00046
+1 -5  4  0  0  0 -0.00019 -0.00019 -0.00019  109.555  0.00028
+1  5 -2  0  0  0  0.00035  0.00035  0.00035  1X3.555 -0.00050
+1  5 -2  0  1  0  0.00022  0.00022  0.00022  1X3.565 -0.00032
+1  5  0 -2  0  0  0.00029  0.00029  0.00029  1X5.355 -0.00041
+1  5  0 -2  1  0  0.00019  0.00019  0.00019  1X5.365 -0.00027
+1  6 -2 -1  0  0  0.00008  0.00008  0.00008  1E3.455 -0.00012
+2 -5  2  3  0  0  0.00010  0.00010  0.00010  207.855  0.00015
+2 -5  4  1  0  0  0.00013  0.00013  0.00013  209.655  0.00018
+2  5 -2 -1  0  0  0.00012  0.00012  0.00012  2X3.455  0.00017
+2  5  0 -1  0  0  0.00022  0.00022  0.00022  2X5.455  0.00032
+2  5  0 -1  1  0  0.00019  0.00019  0.00019  2X5.465  0.00028
+3 -3  2  1  0  0  0.00011  0.00011  0.00011  327.655 -0.00017

{pytmd-2.2.1 → pytmd-2.2.2}/pyTMD/io/constituents.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 u"""
 constituents.py
-Written by Tyler Sutterley (11/2024)
+Written by Tyler Sutterley (02/2025)
 Basic tide model constituent class
 
 PYTHON DEPENDENCIES:
@@ -10,6 +10,7 @@ PYTHON DEPENDENCIES:
         https://numpy.org/doc/stable/user/numpy-for-matlab-users.html
 
 UPDATE HISTORY:
+    Updated 02/2025: add RHO to rho1 to known mappable constituents
     Updated 11/2024: added property for Extended Doodson numbers
     Updated 10/2024: added property for the shape of constituent fields
     Updated 09/2024: add more known constituents to string parser function
@@ -241,13 +242,14 @@ class constituents:
         # include negative look-behind and look-ahead for complex cases
         cindex = [r'(?<!s)sa','ssa','mm','msf',r'mt(?!m)(?!ide)','mf','alpha1',
             '2q1','sigma1',r'(?<!2)q1','rho1',r'(?<!rh)(?<!o)(?<!s)o1','tau1',
-            'm1','chi1','pi1','p1','s1','k1','psi1','phi1','beta1','theta1','j1',
-            'oo1','2n2','mu2',r'(?<!2)n2','nu2',r'(?<!2s)m2(?!a)(?!b)',
-            'm2a','m2b','lambda2','l2','t2',r'(?<!mn)(?<!mk)(?<!ep)s2(?!0)',
-            'alpha2','beta2','delta2','gamma2','r2','k2',r'(?<!b)eta2',
-            'mns2','2sm2','m3','mk3','s3','mn4','m4','ms4','mk4','so1',
-            r'(?<!m)s4','s5','m6','s6','s7','s8','m8','mks2','msqm','mtm',
-            r'(?<!m)n4','eps2','ups1','z0','node']
+            'm1','chi1','pi1',r'(?<!al)p1','s1','k1','psi1','phi1','beta1',
+            'theta1','j1','oo1','2n2','mu2',r'(?<!2)n2','nu2',
+            r'(?<!2s)(?<!l)(?<!la)(?<!ga)m2(?!a)(?!b)','m2a','m2b','lambda2',
+            r'(?<!de)l2',r'(?<!be)t2',r'(?<!mn)(?<!mk)(?<!ep)s2(?!0)','alpha2',
+            'beta2','delta2','gamma2','r2','k2',r'(?<!b)eta2','mns2','2sm2',
+            'm3','mk3','s3','mn4','m4','ms4','mk4','so1',r'(?<!m)s4','s5','m6',
+            's6','s7','s8','m8','mks2','msqm','mtm',r'(?<!m)n4','eps2','ups1',
+            'z0','node']
         # compile regular expression
         # adding GOT prime nomenclature for 3rd degree constituents
         rx = re.compile(r'(' + '|'.join(cindex) + r')(\')?', re.IGNORECASE)
@@ -256,10 +258,12 @@ class constituents:
             return "".join(rx.findall(constituent)[0]).lower()
         # known remapped cases
         mapping = [('2n','2n2'), ('alp1', 'alpha1'), ('alp2', 'alpha2'),
-            ('bet1', 'beta1'), ('bet2', 'beta2'), ('e2','eps2'),
-            ('del2', 'delta2'), ('gam2', 'gamma2'),
-            ('la2','lambda2'), ('lam2','lambda2'),
-            ('sig1','sigma1'), ('the1', 'theta1')]
+            ('bet1', 'beta1'), ('bet2', 'beta2'), ('del2', 'delta2'),
+            ('e2','eps2'), ('ep2','eps2'), ('gam2', 'gamma2'),
+            ('la2','lambda2'), ('lam2','lambda2'), ('lm2','lambda2'),
+            ('msq', 'msqm'), ('omega0', 'node'), ('om0', 'node'),
+            ('rho', 'rho1'), ('sig1','sigma1'),
+            ('the', 'theta1'), ('the1', 'theta1')]
         # iterate over known remapped cases
         for m in mapping:
             # check if tide model is a remapped case