nrl-tracker 0.21.4__py3-none-any.whl → 0.22.0__py3-none-any.whl

pytcl/gravity/__init__.py

@@ -19,71 +19,61 @@ Examples
 >>> print(f"Gravity magnitude: {result.magnitude:.4f} m/s^2")
 """
 
-from pytcl.gravity.clenshaw import (
-    clenshaw_gravity,
-    clenshaw_potential,
-    clenshaw_sum_order,
-    clenshaw_sum_order_derivative,
-)
-from pytcl.gravity.egm import (
-    EGMCoefficients,
-    GeoidResult,
-    GravityDisturbance,
-    create_test_coefficients,
-    deflection_of_vertical,
-    geoid_height,
-    geoid_heights,
-    get_data_dir,
-    gravity_anomaly,
-    gravity_disturbance,
-    load_egm_coefficients,
-)
-from pytcl.gravity.models import (
-    GRS80,
-    WGS84,
-    GravityConstants,
-    GravityResult,
-    bouguer_anomaly,
-    free_air_anomaly,
-    geoid_height_j2,
-    gravitational_potential,
-    gravity_j2,
-    gravity_wgs84,
-    normal_gravity,
-    normal_gravity_somigliana,
-)
-from pytcl.gravity.spherical_harmonics import (
-    associated_legendre,
-    associated_legendre_derivative,
-    associated_legendre_scaled,
-    gravity_acceleration,
-    legendre_scaling_factors,
-    spherical_harmonic_sum,
-)
-from pytcl.gravity.tides import (
-    GRAVIMETRIC_FACTOR,
-    LOVE_H2,
-    LOVE_H3,
-    LOVE_K2,
-    LOVE_K3,
-    SHIDA_L2,
-    SHIDA_L3,
-    TIDAL_CONSTITUENTS,
-    OceanTideLoading,
-    TidalDisplacement,
-    TidalGravity,
-    atmospheric_pressure_loading,
-    fundamental_arguments,
-    julian_centuries_j2000,
-    moon_position_approximate,
-    ocean_tide_loading_displacement,
-    pole_tide_displacement,
-    solid_earth_tide_displacement,
-    solid_earth_tide_gravity,
-    sun_position_approximate,
-    tidal_gravity_correction,
-    total_tidal_displacement,
-)
+from pytcl.gravity.clenshaw import clenshaw_gravity
+from pytcl.gravity.clenshaw import clenshaw_potential
+from pytcl.gravity.clenshaw import clenshaw_sum_order
+from pytcl.gravity.clenshaw import clenshaw_sum_order_derivative
+from pytcl.gravity.egm import EGMCoefficients
+from pytcl.gravity.egm import GeoidResult
+from pytcl.gravity.egm import GravityDisturbance
+from pytcl.gravity.egm import create_test_coefficients
+from pytcl.gravity.egm import deflection_of_vertical
+from pytcl.gravity.egm import geoid_height
+from pytcl.gravity.egm import geoid_heights
+from pytcl.gravity.egm import get_data_dir
+from pytcl.gravity.egm import gravity_anomaly
+from pytcl.gravity.egm import gravity_disturbance
+from pytcl.gravity.egm import load_egm_coefficients
+from pytcl.gravity.models import GRS80
+from pytcl.gravity.models import WGS84
+from pytcl.gravity.models import GravityConstants
+from pytcl.gravity.models import GravityResult
+from pytcl.gravity.models import bouguer_anomaly
+from pytcl.gravity.models import free_air_anomaly
+from pytcl.gravity.models import geoid_height_j2
+from pytcl.gravity.models import gravitational_potential
+from pytcl.gravity.models import gravity_j2
+from pytcl.gravity.models import gravity_wgs84
+from pytcl.gravity.models import normal_gravity
+from pytcl.gravity.models import normal_gravity_somigliana
+from pytcl.gravity.spherical_harmonics import associated_legendre
+from pytcl.gravity.spherical_harmonics import associated_legendre_derivative
+from pytcl.gravity.spherical_harmonics import associated_legendre_scaled
+from pytcl.gravity.spherical_harmonics import gravity_acceleration
+from pytcl.gravity.spherical_harmonics import legendre_scaling_factors
+from pytcl.gravity.spherical_harmonics import spherical_harmonic_sum
+from pytcl.gravity.tides import GRAVIMETRIC_FACTOR
+from pytcl.gravity.tides import LOVE_H2
+from pytcl.gravity.tides import LOVE_H3
+from pytcl.gravity.tides import LOVE_K2
+from pytcl.gravity.tides import LOVE_K3
+from pytcl.gravity.tides import SHIDA_L2
+from pytcl.gravity.tides import SHIDA_L3
+from pytcl.gravity.tides import TIDAL_CONSTITUENTS
+from pytcl.gravity.tides import OceanTideLoading
+from pytcl.gravity.tides import TidalDisplacement
+from pytcl.gravity.tides import TidalGravity
+from pytcl.gravity.tides import atmospheric_pressure_loading
+from pytcl.gravity.tides import fundamental_arguments
+from pytcl.gravity.tides import julian_centuries_j2000
+from pytcl.gravity.tides import moon_position_approximate
+from pytcl.gravity.tides import ocean_tide_loading_displacement
+from pytcl.gravity.tides import pole_tide_displacement
+from pytcl.gravity.tides import solid_earth_tide_displacement
+from pytcl.gravity.tides import solid_earth_tide_gravity
+from pytcl.gravity.tides import sun_position_approximate
+from pytcl.gravity.tides import tidal_gravity_correction
+from pytcl.gravity.tides import total_tidal_displacement
 
 __all__ = [
     # Spherical harmonics

pytcl/gravity/clenshaw.py

@@ -19,7 +19,8 @@ References
        Journal of Geodesy 82.4-5 (2008): 223-229.
 """
 
-from typing import Optional, Tuple
+from typing import Optional
+from typing import Tuple
 
 import numpy as np
 from numpy.typing import NDArray
@@ -407,9 +408,7 @@ def clenshaw_potential(
     V = 0.0
 
     for m in range(n_max + 1):
-        sum_C, sum_S = clenshaw_sum_order(
-            m, cos_theta, sin_theta, C_scaled, S_scaled, n_max
-        )
+        sum_C, sum_S = clenshaw_sum_order(m, cos_theta, sin_theta, C_scaled, S_scaled, n_max)
 
         cos_m_lon = np.cos(m * lon)
         sin_m_lon = np.sin(m * lon)
@@ -498,9 +497,7 @@ def clenshaw_gravity(
 
     for m in range(n_max + 1):
         # Value sum
-        sum_C, sum_S = clenshaw_sum_order(
-            m, cos_theta, sin_theta, C_scaled, S_scaled, n_max
-        )
+        sum_C, sum_S = clenshaw_sum_order(m, cos_theta, sin_theta, C_scaled, S_scaled, n_max)
 
         # Radial derivative sum
         sum_C_r, sum_S_r = clenshaw_sum_order(

pytcl/gravity/egm.py

@@ -24,13 +24,18 @@ References
 import os
 from functools import lru_cache
 from pathlib import Path
-from typing import Dict, NamedTuple, Optional, Tuple
+from typing import Dict
+from typing import NamedTuple
+from typing import Optional
+from typing import Tuple
 
 import numpy as np
 from numpy.typing import NDArray
 
-from .clenshaw import clenshaw_gravity, clenshaw_potential
-from .models import WGS84, normal_gravity_somigliana
+from .clenshaw import clenshaw_gravity
+from .clenshaw import clenshaw_potential
+from .models import WGS84
+from .models import normal_gravity_somigliana
 
 
 class EGMCoefficients(NamedTuple):
@@ -491,9 +496,7 @@ def geoid_heights(
     # Compute for each point
     heights = np.zeros(len(lats))
     for i in range(len(lats)):
-        heights[i] = geoid_height(
-            lats[i], lons[i], model, n_max, coefficients=coefficients
-        )
+        heights[i] = geoid_height(lats[i], lons[i], model, n_max, coefficients=coefficients)
 
     return heights
 

pytcl/gravity/models.py

@@ -190,9 +190,7 @@ def normal_gravity(
     sin2_lat = np.sin(lat) ** 2
 
     # Height correction
-    gamma = gamma_0 * (
-        1 - 2 / a * (1 + f + m - 2 * f * sin2_lat) * h + 3 / (a * a) * h * h
-    )
+    gamma = gamma_0 * (1 - 2 / a * (1 + f + m - 2 * f * sin2_lat) * h + 3 / (a * a) * h * h)
 
     return gamma
 

pytcl/gravity/spherical_harmonics.py

@@ -11,7 +11,8 @@ References
 .. [2] O. Montenbruck and E. Gill, "Satellite Orbits," Springer, 2000.
 """
 
-from typing import Optional, Tuple
+from typing import Optional
+from typing import Tuple
 
 import numpy as np
 from numpy.typing import NDArray
@@ -94,9 +95,7 @@ def associated_legendre(
                 b_nm = np.sqrt(((n - 1) ** 2 - m * m) / (4 * (n - 1) ** 2 - 1))
                 P[n, m] = a_nm * (x * P[n - 1, m] - b_nm * P[n - 2, m])
             else:
-                P[n, m] = (
-                    (2 * n - 1) * x * P[n - 1, m] - (n + m - 1) * P[n - 2, m]
-                ) / (n - m)
+                P[n, m] = ((2 * n - 1) * x * P[n - 1, m] - (n + m - 1) * P[n - 2, m]) / (n - m)
 
     return P
 
@@ -157,8 +156,7 @@ def associated_legendre_derivative(
                         factor = np.sqrt((n - m) * (n + m + 1))
                         if m + 1 <= m_max and n >= m + 1:
                             dP[n, m] = (
-                                n * x / u2 * P[n, m]
-                                - factor / np.sqrt(u2) * P[n, m + 1]
+                                n * x / u2 * P[n, m] - factor / np.sqrt(u2) * P[n, m + 1]
                                 if m + 1 <= n
                                 else n * x / u2 * P[n, m]
                             )
@@ -166,9 +164,7 @@ def associated_legendre_derivative(
                             dP[n, m] = n * x / u2 * P[n, m]
                 else:
                     # Unnormalized form
-                    dP[n, m] = (
-                        (n * x * P[n, m] - (n + m) * P[n - 1, m]) / u2 if n > 0 else 0
-                    )
+                    dP[n, m] = (n * x * P[n, m] - (n + m) * P[n - 1, m]) / u2 if n > 0 else 0
 
     return dP
 
@@ -488,8 +484,7 @@ def associated_legendre_scaled(
             s_ratio_2 = scale[n] / scale[n - 2]
 
             P_scaled[n, m] = a_nm * (
-                x * P_scaled[n - 1, m] * s_ratio_1
-                - b_nm * P_scaled[n - 2, m] * s_ratio_2
+                x * P_scaled[n - 1, m] * s_ratio_1 - b_nm * P_scaled[n - 2, m] * s_ratio_2
             )
 
     return P_scaled, scale_exp

pytcl/gravity/tides.py

@@ -20,7 +20,8 @@ References
        displacements," JGR, 102, B9, 20469-20477, 1997.
 """
 
-from typing import NamedTuple, Tuple
+from typing import NamedTuple
+from typing import Tuple
 
 import numpy as np
 from numpy.typing import NDArray
@@ -179,36 +180,31 @@ def fundamental_arguments(T: float) -> Tuple[float, float, float, float, float]:
     # Mean anomaly of the Moon (l)
     l_moon = (
         134.96340251
-        + (1717915923.2178 * T + 31.8792 * T**2 + 0.051635 * T**3 - 0.00024470 * T**4)
-        / 3600.0
+        + (1717915923.2178 * T + 31.8792 * T**2 + 0.051635 * T**3 - 0.00024470 * T**4) / 3600.0
     ) * deg2rad
 
     # Mean anomaly of the Sun (l')
     l_sun = (
         357.52910918
-        + (129596581.0481 * T - 0.5532 * T**2 + 0.000136 * T**3 - 0.00001149 * T**4)
-        / 3600.0
+        + (129596581.0481 * T - 0.5532 * T**2 + 0.000136 * T**3 - 0.00001149 * T**4) / 3600.0
     ) * deg2rad
 
     # Mean argument of latitude of the Moon (F)
     F = (
         93.27209062
-        + (1739527262.8478 * T - 12.7512 * T**2 - 0.001037 * T**3 + 0.00000417 * T**4)
-        / 3600.0
+        + (1739527262.8478 * T - 12.7512 * T**2 - 0.001037 * T**3 + 0.00000417 * T**4) / 3600.0
     ) * deg2rad
 
     # Mean elongation of the Moon from the Sun (D)
     D = (
         297.85019547
-        + (1602961601.2090 * T - 6.3706 * T**2 + 0.006593 * T**3 - 0.00003169 * T**4)
-        / 3600.0
+        + (1602961601.2090 * T - 6.3706 * T**2 + 0.006593 * T**3 - 0.00003169 * T**4) / 3600.0
     ) * deg2rad
 
     # Mean longitude of the ascending node of the Moon (Omega)
     Omega = (
         125.04455501
-        + (-6962890.5431 * T + 7.4722 * T**2 + 0.007702 * T**3 - 0.00005939 * T**4)
-        / 3600.0
+        + (-6962890.5431 * T + 7.4722 * T**2 + 0.007702 * T**3 - 0.00005939 * T**4) / 3600.0
     ) * deg2rad
 
     return (
@@ -279,9 +275,7 @@ def moon_position_approximate(mjd: float) -> Tuple[float, float, float]:
 
     # Distance perturbations (km)
     r_pert = (
-        -20.905355 * np.cos(M_prime)
-        - 3.699111 * np.cos(2 * D - M_prime)
-        - 2.955968 * np.cos(2 * D)
+        -20.905355 * np.cos(M_prime) - 3.699111 * np.cos(2 * D - M_prime) - 2.955968 * np.cos(2 * D)
     ) * 1000  # Convert to km
 
     # Final position
@@ -586,9 +580,7 @@ def solid_earth_tide_gravity(
     delta_g_north = 0.0
     delta_g_east = 0.0
 
-    return TidalGravity(
-        delta_g=delta_g, delta_g_north=delta_g_north, delta_g_east=delta_g_east
-    )
+    return TidalGravity(delta_g=delta_g, delta_g_north=delta_g_north, delta_g_east=delta_g_east)
 
 
 def ocean_tide_loading_displacement(

pytcl/magnetism/__init__.py

@@ -25,44 +25,34 @@ Examples
 >>> coef = create_emm_test_coefficients(n_max=36)
 """
 
-from pytcl.magnetism.emm import (
-    EMM_PARAMETERS,
-    HighResCoefficients,
-)
+from pytcl.magnetism.emm import EMM_PARAMETERS
+from pytcl.magnetism.emm import HighResCoefficients
 from pytcl.magnetism.emm import create_test_coefficients as create_emm_test_coefficients
-from pytcl.magnetism.emm import (
-    emm,
-    emm_declination,
-    emm_inclination,
-    emm_intensity,
-)
+from pytcl.magnetism.emm import emm
+from pytcl.magnetism.emm import emm_declination
+from pytcl.magnetism.emm import emm_inclination
+from pytcl.magnetism.emm import emm_intensity
 from pytcl.magnetism.emm import get_data_dir as get_emm_data_dir
-from pytcl.magnetism.emm import (
-    load_emm_coefficients,
-    wmmhr,
-)
-from pytcl.magnetism.igrf import (
-    IGRF13,
-    IGRFModel,
-    create_igrf13_coefficients,
-    dipole_axis,
-    dipole_moment,
-    igrf,
-    igrf_declination,
-    igrf_inclination,
-    magnetic_north_pole,
-)
-from pytcl.magnetism.wmm import (
-    WMM2020,
-    MagneticCoefficients,
-    MagneticResult,
-    create_wmm2020_coefficients,
-    magnetic_declination,
-    magnetic_field_intensity,
-    magnetic_field_spherical,
-    magnetic_inclination,
-    wmm,
-)
+from pytcl.magnetism.emm import load_emm_coefficients
+from pytcl.magnetism.emm import wmmhr
+from pytcl.magnetism.igrf import IGRF13
+from pytcl.magnetism.igrf import IGRFModel
+from pytcl.magnetism.igrf import create_igrf13_coefficients
+from pytcl.magnetism.igrf import dipole_axis
+from pytcl.magnetism.igrf import dipole_moment
+from pytcl.magnetism.igrf import igrf
+from pytcl.magnetism.igrf import igrf_declination
+from pytcl.magnetism.igrf import igrf_inclination
+from pytcl.magnetism.igrf import magnetic_north_pole
+from pytcl.magnetism.wmm import WMM2020
+from pytcl.magnetism.wmm import MagneticCoefficients
+from pytcl.magnetism.wmm import MagneticResult
+from pytcl.magnetism.wmm import create_wmm2020_coefficients
+from pytcl.magnetism.wmm import magnetic_declination
+from pytcl.magnetism.wmm import magnetic_field_intensity
+from pytcl.magnetism.wmm import magnetic_field_spherical
+from pytcl.magnetism.wmm import magnetic_inclination
+from pytcl.magnetism.wmm import wmm
 
 __all__ = [
     # Types and constants

pytcl/magnetism/emm.py

@@ -24,7 +24,10 @@ References
 import os
 from functools import lru_cache
 from pathlib import Path
-from typing import Dict, NamedTuple, Optional, Tuple
+from typing import Dict
+from typing import NamedTuple
+from typing import Optional
+from typing import Tuple
 
 import numpy as np
 from numpy.typing import NDArray
@@ -531,8 +534,7 @@ def _high_res_field_spherical(
                     factor = np.sqrt((n - m) * (n + m + 1))
                     if m + 1 <= n:
                         dP[n, m] = (
-                            n * cos_theta / sin_theta * P[n, m]
-                            - factor * P[n, m + 1] / sin_theta
+                            n * cos_theta / sin_theta * P[n, m] - factor * P[n, m + 1] / sin_theta
                             if m + 1 <= n_max_eval
                             else n * cos_theta / sin_theta * P[n, m]
                         )
@@ -559,13 +561,7 @@ def _high_res_field_spherical(
             B_theta += -r_power * dP[n, m] * (gnm * cos_m_lon + hnm * sin_m_lon)
 
             if abs(sin_theta) > 1e-10:
-                B_phi += (
-                    r_power
-                    * m
-                    * P[n, m]
-                    / sin_theta
-                    * (gnm * sin_m_lon - hnm * cos_m_lon)
-                )
+                B_phi += r_power * m * P[n, m] / sin_theta * (gnm * sin_m_lon - hnm * cos_m_lon)
 
     return B_r, B_theta, B_phi
 
@@ -624,9 +620,7 @@ def emm(
     r = a + h
 
     # Compute field in spherical coordinates
-    B_r, B_theta, B_phi = _high_res_field_spherical(
-        lat_gc, lon, r, year, coefficients, n_max
-    )
+    B_r, B_theta, B_phi = _high_res_field_spherical(lat_gc, lon, r, year, coefficients, n_max)
 
     # Convert to geodetic coordinates
     X = -B_theta  # North

pytcl/magnetism/igrf.py

@@ -12,15 +12,14 @@ References
 .. [2] https://www.ngdc.noaa.gov/IAGA/vmod/igrf.html
 """
 
-from typing import NamedTuple, Optional
+from typing import NamedTuple
+from typing import Optional
 
 import numpy as np
 
-from pytcl.magnetism.wmm import (
-    MagneticCoefficients,
-    MagneticResult,
-    magnetic_field_spherical,
-)
+from pytcl.magnetism.wmm import MagneticCoefficients
+from pytcl.magnetism.wmm import MagneticResult
+from pytcl.magnetism.wmm import magnetic_field_spherical
 
 
 class IGRFModel(NamedTuple):

pytcl/magnetism/wmm.py

@@ -12,7 +12,8 @@ References
 .. [2] https://www.ngdc.noaa.gov/geomag/WMM/
 """
 
-from typing import NamedTuple, Tuple
+from typing import NamedTuple
+from typing import Tuple
 
 import numpy as np
 from numpy.typing import NDArray
@@ -468,8 +469,7 @@ def magnetic_field_spherical(
                     factor = np.sqrt((n - m) * (n + m + 1))
                     if m + 1 <= n:
                         dP[n, m] = (
-                            n * cos_theta / sin_theta * P[n, m]
-                            - factor * P[n, m + 1] / sin_theta
+                            n * cos_theta / sin_theta * P[n, m] - factor * P[n, m + 1] / sin_theta
                             if m + 1 <= n_max
                             else n * cos_theta / sin_theta * P[n, m]
                         )
@@ -499,13 +499,7 @@ def magnetic_field_spherical(
             B_theta += -r_power * dP[n, m] * (gnm * cos_m_lon + hnm * sin_m_lon)
 
             if abs(sin_theta) > 1e-10:
-                B_phi += (
-                    r_power
-                    * m
-                    * P[n, m]
-                    / sin_theta
-                    * (gnm * sin_m_lon - hnm * cos_m_lon)
-                )
+                B_phi += r_power * m * P[n, m] / sin_theta * (gnm * sin_m_lon - hnm * cos_m_lon)
 
     return B_r, B_theta, B_phi