ci: add windows build for #98 (#369)

* fix: omega and phase in constituent parameters * refactor: move body tide Love/Shida numbers to `arguments` * ci: add windows build for #98 * test: create test files from matlab program for comparison * fix: add `missing_ok` to deletions in tests * fix: verify that file objects are closed in `test_spatial`
tsutterley · Dec 3, 2024 · 4bc3d0e · 4bc3d0e
1 parent e1eccc0
commit 4bc3d0e
Show file tree

Hide file tree

Showing 19 changed files with 490 additions and 284 deletions.
diff --git a/.github/workflows/python-request.yml b/.github/workflows/python-request.yml
@@ -15,7 +15,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
         python-version: [3.11]
     env:
       OS: ${{ matrix.os }}
@@ -45,8 +45,6 @@ jobs:
           cython
           geopandas
           jplephem
-          octave
-          oct2py
           pyarrow
     - name: Lint with flake8
       run: |

diff --git a/doc/source/api_reference/arguments.rst b/doc/source/api_reference/arguments.rst
@@ -36,6 +36,8 @@ Calling Sequence
 
 .. autofunction:: pyTMD.arguments._constituent_parameters
 
+.. autofunction:: pyTMD.arguments._love_numbers
+
 .. autofunction:: pyTMD.arguments._parse_tide_potential_table
 
 .. autofunction:: pyTMD.arguments._to_doodson_number

diff --git a/doc/source/api_reference/predict.rst b/doc/source/api_reference/predict.rst
@@ -40,8 +40,6 @@ Calling Sequence
 
 .. autofunction:: pyTMD.predict._infer_long_period
 
-.. autofunction:: pyTMD.predict._body_tide_love_numbers
-
 .. autofunction:: pyTMD.predict.equilibrium_tide
 
 .. autofunction:: pyTMD.predict.load_pole_tide

diff --git a/pyTMD/arguments.py b/pyTMD/arguments.py
@@ -40,6 +40,7 @@
 UPDATE HISTORY:
     Updated 11/2024: allow variable case for Doodson number formalisms
         fix species in constituent parameters for complex tides
+        move body tide Love/Shida numbers from predict module
     Updated 10/2024: can convert Doodson numbers formatted as strings
         update Doodson number conversions to follow Cartwright X=10 convention
         add function to parse Cartwright/Tayler/Edden tables
@@ -93,6 +94,7 @@
     "_arguments_table",
     "_minor_table",
     "_constituent_parameters",
+    "_love_numbers",
     "_parse_tide_potential_table",
     "_to_doodson_number",
     "_to_extended_doodson",
@@ -1420,7 +1422,7 @@ def _constituent_parameters(c: str, **kwargs):
     _omega = np.array([1.405189e-04, 1.454441e-04, 7.292117e-05, 6.759774e-05,
         1.378797e-04, 7.252295e-05, 1.458423e-04, 6.495854e-05, 1.352405e-04,
         1.355937e-04, 1.382329e-04, 1.431581e-04, 1.452450e-04, 7.556036e-05,
-        7.028195e-05, 7.824458e-05, 6.531174e-05, 0.053234e-04, 0.026392e-04,
+        7.025945e-05, 7.824458e-05, 6.531174e-05, 0.053234e-04, 0.026392e-04,
         0.003982e-04, 2.810377e-04, 2.859630e-04, 2.783984e-04, 4.215566e-04,
         5.620755e-04, 2.134402e-04, 4.363323e-04, 1.503693e-04, 2.081166e-04,
         4.925200e-06, 1.990970e-07, 7.962619e-06, 6.231934e-05])
@@ -1429,10 +1431,10 @@ def _constituent_parameters(c: str, **kwargs):
     # the forcing for that constituent is zero on the Greenwich meridian
     _phase = np.array([1.731557546, 0.000000000, 0.173003674, 1.558553872,
         6.050721243, 6.110181633, 3.487600001, 5.877717569, 4.086699633,
-        3.463115091, 5.427136701, 0.553986502, 0.052841931, 2.137025284,
-        2.436575100, 1.929046130, 5.254133027, 1.756042456, 1.964021610,
+        3.463115091, 5.427136701, 0.553986502, 0.050398470, 2.137025284,
+        2.436575000, 1.929046130, 5.254133027, 1.756042456, 1.964021610,
         3.487600001, 3.463115091, 1.731557546, 1.499093481, 5.194672637,
-        6.926230184, 1.904561220, 0.000000000, 4.551627762, 3.809122439,
+        6.926230184, 1.904561220, 0.000000000, 4.551627762, 3.290111417,
         4.551627762, 6.232786837, 3.720064066, 3.91369596])
     # amplitudes of equilibrium tide in meters
     # _amplitude = np.array([0.242334,0.112743,0.141565,0.100661,0.046397,
@@ -1462,6 +1464,105 @@ def _constituent_parameters(c: str, **kwargs):
     # return the values for the constituent
     return (amplitude, phase, omega, alpha, species)
 
+def _love_numbers(
+        omega: np.ndarray,
+        model: str = 'PREM'
+    ):
+    """
+    Compute the body tide Love/Shida numbers for a given
+    frequency [1]_ [2]_ [3]_
+
+    Parameters
+    ----------
+    omega: np.ndarray
+        angular frequency (radians per second)
+    model: str, default 'PREM'
+        Earth model to use for Love numbers
+
+            - '1066A'
+            - 'PEM-C'
+            - 'C2'
+            - 'PREM'
+
+    Returns
+    -------
+    h2: float
+        Degree-2 Love number of vertical displacement
+    k2: float
+        Degree-2 Love number of gravitational potential
+    l2: float
+        Degree-2 Love (Shida) number of horizontal displacement
+
+    References
+    ----------
+    .. [1] J. M. Wahr, "Body tides on an elliptical, rotating, elastic
+        and oceanless Earth", *Geophysical Journal of the Royal
+        Astronomical Society*, 64(3), 677--703, (1981).
+        `doi: 10.1111/j.1365-246X.1981.tb02690.x
+        <https://doi.org/10.1111/j.1365-246X.1981.tb02690.x>`_
+    .. [2] J. M. Wahr and T. Sasao, "A diurnal resonance in the ocean
+        tide and in the Earth's load response due to the resonant free
+        `core nutation`", *Geophysical Journal of the Royal Astronomical
+        Society*, 64(3), 747--765, (1981).
+        `doi: 10.1111/j.1365-246X.1981.tb02693.x
+        <https://doi.org/10.1111/j.1365-246X.1981.tb02693.x>`_
+    .. [3] P. M. Mathews, B. A. Buffett, and I. I. Shapiro,
+        "Love numbers for diurnal tides: Relation to wobble admittances
+        and resonance expansions", *Journal of Geophysical Research:
+        Solid Earth*, 100(B6), 9935--9948, (1995).
+        `doi: 10.1029/95jb00670 <https://doi.org/10.1029/95jb00670>`_
+    """
+    # free core nutation frequencies (cycles per sidereal day) and
+    # Love number parameters from Wahr (1981) table 6
+    # and Mathews et al. (1995) table 3
+    if (model == '1066A'):
+        fcn = 1.0021714
+        h0, h1 = np.array([6.03e-1, -2.46e-3])
+        k0, k1 = np.array([2.98e-1, -1.23e-3])
+        l0, l1 = np.array([8.42e-2, 7.81e-5])
+    elif (model == 'PEM-C'):
+        fcn = 1.0021771
+        h0, h1 = np.array([6.02e-1, -2.46e-3])
+        k0, k1 = np.array([2.98e-1, -1.24e-3])
+        l0, l1 = np.array([8.39e-2, 7.69e-5])
+    elif (model == 'C2'):
+        fcn = 1.0021844
+        h0, h1 = np.array([6.02e-1, -2.45e-3])
+        k0, k1 = np.array([2.98e-1, -1.23e-3])
+        l0, l1 = np.array([8.46e-2, 7.58e-5])
+    elif (model == 'PREM'):
+        fcn = 1.0023214
+        h0, h1 = np.array([5.994e-1, -2.532e-3])
+        k0, k1 = np.array([2.962e-1, -1.271e-3])
+        l0, l1 = np.array([8.378e-2, 7.932e-5])
+    else:
+        raise ValueError(f'Unknown Earth model: {model}')
+    # Love numbers for different frequency bands
+    if (omega > 1e-4):
+        # tides in the semi-diurnal band
+        h2 = 0.609
+        k2 = 0.302
+        l2 = 0.0852
+    elif (omega < 2e-5):
+        # tides in the long period band
+        h2 = 0.606
+        k2 = 0.299
+        l2 = 0.0840
+    else:
+        # use resonance formula for tides in the diurnal band
+        # frequency of the o1 tides (radians/second)
+        omega_o1, = frequency('o1')
+        # frequency of free core nutation (radians/second)
+        omega_fcn = fcn*7292115e-11
+        # Love numbers for frequency using equation 4.18 of Wahr (1981)
+        # (simplification to use only the free core nutation term)
+        ratio = (omega - omega_o1)/(omega_fcn - omega)
+        h2 = h0 + h1*ratio
+        k2 = k0 + k1*ratio
+        l2 = l0 + l1*ratio
+    # return the Love numbers for frequency
+    return (h2, k2, l2)
+
 # 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

diff --git a/pyTMD/predict.py b/pyTMD/predict.py
@@ -21,6 +21,7 @@
 
 UPDATE HISTORY:
     Updated 11/2024: use Love numbers for long-period tides when inferring
+        move body tide Love/Shida numbers to arguments module
     Updated 10/2024: use PREM as the default Earth model for Love numbers
         more descriptive error message if cannot infer minor constituents
         updated calculation of long-period equilibrium tides
@@ -80,7 +81,6 @@
     "_infer_semi_diurnal",
     "_infer_diurnal",
     "_infer_long_period",
-    "_body_tide_love_numbers",
     "equilibrium_tide",
     "load_pole_tide",
     "ocean_pole_tide",
@@ -772,7 +772,7 @@ def _infer_diurnal(
         if j:
             j1, = j
             # Love numbers of degree 2 for constituent
-            h2, k2, l2 = _body_tide_love_numbers(omajor[i])
+            h2, k2, l2 = pyTMD.arguments._love_numbers(omajor[i])
             # tilt factor: response with respect to the solid earth
             gamma_2 = (1.0 + k2 - h2)
             # "normalize" tide values
@@ -835,7 +835,7 @@ def _infer_diurnal(
     # sum over the minor tidal constituents of interest
     for k in minor_indices:
         # Love numbers of degree 2 for constituent
-        h2, k2, l2 = _body_tide_love_numbers(omega[k])
+        h2, k2, l2 = pyTMD.arguments._love_numbers(omega[k])
         # tilt factor: response with respect to the solid earth
         gamma_2 = (1.0 + k2 - h2)
         # interpolate from major constituents
@@ -1005,105 +1005,6 @@ def _infer_long_period(
     # return the inferred values
     return dh
 
-def _body_tide_love_numbers(
-        omega: np.ndarray,
-        model: str = 'PREM'
-    ):
-    """
-    Compute the body tide Love/Shida numbers for a given
-    frequency [1]_ [2]_ [3]_
-
-    Parameters
-    ----------
-    omega: np.ndarray
-        angular frequency (radians per second)
-    model: str, default 'PREM'
-        Earth model to use for Love numbers
-
-            - '1066A'
-            - 'PEM-C'
-            - 'C2'
-            - 'PREM'
-
-    Returns
-    -------
-    h2: float
-        Degree-2 Love number of vertical displacement
-    k2: float
-        Degree-2 Love number of gravitational potential
-    l2: float
-        Degree-2 Love (Shida) number of horizontal displacement
-
-    References
-    ----------
-    .. [1] J. M. Wahr, "Body tides on an elliptical, rotating, elastic
-        and oceanless Earth", *Geophysical Journal of the Royal
-        Astronomical Society*, 64(3), 677--703, (1981).
-        `doi: 10.1111/j.1365-246X.1981.tb02690.x
-        <https://doi.org/10.1111/j.1365-246X.1981.tb02690.x>`_
-    .. [2] J. M. Wahr and T. Sasao, "A diurnal resonance in the ocean
-        tide and in the Earth's load response due to the resonant free
-        `core nutation`", *Geophysical Journal of the Royal Astronomical
-        Society*, 64(3), 747--765, (1981).
-        `doi: 10.1111/j.1365-246X.1981.tb02693.x
-        <https://doi.org/10.1111/j.1365-246X.1981.tb02693.x>`_
-    .. [3] P. M. Mathews, B. A. Buffett, and I. I. Shapiro,
-        "Love numbers for diurnal tides: Relation to wobble admittances
-        and resonance expansions", *Journal of Geophysical Research:
-        Solid Earth*, 100(B6), 9935--9948, (1995).
-        `doi: 10.1029/95jb00670 <https://doi.org/10.1029/95jb00670>`_
-    """
-    # free core nutation frequencies (cycles per sidereal day) and
-    # Love number parameters from Wahr (1981) table 6
-    # and Mathews et al. (1995) table 3
-    if (model == '1066A'):
-        fcn = 1.0021714
-        h0, h1 = np.array([6.03e-1, -2.46e-3])
-        k0, k1 = np.array([2.98e-1, -1.23e-3])
-        l0, l1 = np.array([8.42e-2, 7.81e-5])
-    elif (model == 'PEM-C'):
-        fcn = 1.0021771
-        h0, h1 = np.array([6.02e-1, -2.46e-3])
-        k0, k1 = np.array([2.98e-1, -1.24e-3])
-        l0, l1 = np.array([8.39e-2, 7.69e-5])
-    elif (model == 'C2'):
-        fcn = 1.0021844
-        h0, h1 = np.array([6.02e-1, -2.45e-3])
-        k0, k1 = np.array([2.98e-1, -1.23e-3])
-        l0, l1 = np.array([8.46e-2, 7.58e-5])
-    elif (model == 'PREM'):
-        fcn = 1.0023214
-        h0, h1 = np.array([5.994e-1, -2.532e-3])
-        k0, k1 = np.array([2.962e-1, -1.271e-3])
-        l0, l1 = np.array([8.378e-2, 7.932e-5])
-    else:
-        raise ValueError(f'Unknown Earth model: {model}')
-    # Love numbers for different frequency bands
-    if (omega > 1e-4):
-        # tides in the semi-diurnal band
-        h2 = 0.609
-        k2 = 0.302
-        l2 = 0.0852
-    elif (omega < 2e-5):
-        # tides in the long period band
-        h2 = 0.606
-        k2 = 0.299
-        l2 = 0.0840
-    else:
-        # use resonance formula for tides in the diurnal band
-        # frequency of the o1 tides (radians/second)
-        omega_o1, = pyTMD.arguments.frequency('o1')
-        # frequency of free core nutation (radians/second)
-        omega_fcn = fcn*7292115e-11
-        # Love numbers for frequency using equation 4.18 of Wahr (1981)
-        # (simplification to use only the free core nutation term)
-        ratio = (omega - omega_o1)/(omega_fcn - omega)
-        h2 = h0 + h1*ratio
-        k2 = k0 + k1*ratio
-        l2 = l0 + l1*ratio
-    # return the Love numbers for frequency
-    return (h2, k2, l2)
-
 # PURPOSE: estimate long-period equilibrium tides
 def equilibrium_tide(
         t: np.ndarray,

diff --git a/test/TMDv2.5_Arc5km2018_U.csv.gz b/test/TMDv2.5_Arc5km2018_U.csv.gz
diff --git a/test/TMDv2.5_Arc5km2018_V.csv.gz b/test/TMDv2.5_Arc5km2018_V.csv.gz
diff --git a/test/TMDv2.5_Arc5km2018_z.csv.gz b/test/TMDv2.5_Arc5km2018_z.csv.gz
diff --git a/test/TMDv2.5_CATS2008_U.csv.gz b/test/TMDv2.5_CATS2008_U.csv.gz
diff --git a/test/TMDv2.5_CATS2008_V.csv.gz b/test/TMDv2.5_CATS2008_V.csv.gz
diff --git a/test/TMDv2.5_CATS2008_ellipse.csv.gz b/test/TMDv2.5_CATS2008_ellipse.csv.gz
diff --git a/test/TMDv2.5_CATS2008_z.csv.gz b/test/TMDv2.5_CATS2008_z.csv.gz
diff --git a/test/test_arguments.py b/test/test_arguments.py
@@ -679,10 +679,10 @@ def test_parameters():
     """
     Test constituent parameter values
     """
-    # parametrized constituents (sans m1 and 2mk3)
+    # parametrized constituents
     cindex = ['m2', 's2', 'k1', 'o1', 'n2', 'p1', 'k2', 'q1', '2n2', 'mu2',
-        'nu2', 'l2', 'j1', 'oo1', 'rho1', 'mf', 'mm', 'ssa',
-        'm4', 'ms4', 'mn4', 'm6', 'm8', 'mk3', 's6', '2sm2', 
+        'nu2', 'l2', 't2', 'j1', 'm1', 'oo1', 'rho1', 'mf', 'mm', 'ssa',
+        'm4', 'ms4', 'mn4', 'm6', 'm8', 'mk3', 's6', '2sm2', '2mk3',
         'msf', 'sa', 'mt', '2q1']
     # number of days between MJD and the tide epoch (1992-01-01T00:00:00)
     MJD = np.atleast_1d(48622.0)
@@ -703,13 +703,14 @@ def test_parameters():
     for i, c in enumerate(cindex):
         # get constituent parameters
         amp, ph, omega, alpha, species = _constituent_parameters(c)
+        # convert phase to degrees
+        phase = np.mod(180.0*ph/np.pi, 360.0)
         # check species
         cartwright = doodson_number(c, formalism='Cartwright')
         assert species == cartwright[0]
         # check frequency calculation
         assert np.isclose(omega, omegas[i])
         # assert phase calculation
-        phase = np.mod(180.0*ph/np.pi, 360.0)
         assert np.isclose(phase, G[0,i])
 
 def test_doodson():