pygnss 0.6.0__cp312-cp312-musllinux_1_2_x86_64.whl → 1.0.0__cp312-cp312-musllinux_1_2_x86_64.whl

pygnss/__init__.py

@@ -1 +1 @@
-__version__ = "0.6.0"
+__version__ = "1.0.0"

pygnss/ionex.py

@@ -4,8 +4,10 @@ import math
 import os
 from typing import List
 
+import nequick
 import numpy as np
 
+
 from .iono import gim
 from .decorator import read_contents
 
@@ -268,14 +270,43 @@ def _parse_ionex_epoch(ionex_line: str) -> datetime.datetime:
     return datetime.datetime.strptime(ionex_line[:36], _HEADER_EPOCH_FORMAT)
 
 
+
+class NeQuickGimHandlerArray(gim.GimHandler):
+    """
+    Handler to store the incoming GIMs in arrays
+    """
+
+    def __init__(self):
+        self.vtec_gims: List[gim.Gim] = []
+
+    def process(self, nequick_gim: nequick.Gim):
+        """
+        Process a GIM file
+        """
+
+        incoming_gim = gim.Gim(nequick_gim.epoch,
+                               nequick_gim.longitudes, nequick_gim.latitudes,
+                               nequick_gim.vtec_values)
+
+        self.vtec_gims.append(incoming_gim)
+
+
 def cli():
     """
     This function allows users to compute the difference between two IONEX files
+    or between an IONEX file and the NeQuick model (with three coefficients),
     and save the result in a new IONEX file.
+
+
+    Example:
+        Compute the difference between two IONEX files:
+        $ python ionex.py file1.ionex file2.ionex output.ionex
+
+        Compute the difference between an IONEX file and the NeQuick model:
+        $ python ionex.py file1.ionex output.ionex --nequick 0.123 0.456 0.789
     """
-    parser = argparse.ArgumentParser(
-        description="Compute the difference between two IONEX files and save the result in a new IONEX file."
-    )
+    parser = argparse.ArgumentParser(description=cli.__doc__,
+                                     formatter_class=argparse.RawDescriptionHelpFormatter )
 
     parser.add_argument(
         "lhs",
@@ -284,19 +315,96 @@ def cli():
     )
 
     parser.add_argument(
-        "rhs",
+        "output",
+        type=str,
+        help="Path to the output IONEX file where the differences will be saved.",
+    )
+
+    rhs = parser.add_mutually_exclusive_group(required=True)
+
+    rhs.add_argument(
+        "--rhs",
         type=str,
-        help="Path to the second IONEX file (right-hand side).",
+        help="Path to the second IONEX file (right-hand side). If not provided, --nequick must be specified.",
+    )
+
+    rhs.add_argument(
+        "--nequick",
+        type=float,
+        nargs=3,
+        metavar=("AZ0", "AZ1", "AZ2"),
+        help="Use the NeQuick model to compare against the 'lhs' IONEX (instead of another IONEX file). "
+        "Specify the three NeQuick coefficients (az0, az1, az2).",
     )
 
     parser.add_argument(
-        "output",
+        "--nequick-ionex",
         type=str,
-        help="Path to the output IONEX file where the differences will be saved.",
+        default=None,
+        required=False,
+        metavar='<file>',
+        help="Specify a filename to store the NeQuick model in IONEX format",
     )
 
     args = parser.parse_args()
 
     PGM = "ionex_diff"
 
-    diff(args.lhs, args.rhs, args.output, pgm=PGM)
+    # Validate input arguments
+    if args.rhs is None and args.nequick is None:
+        parser.error("Either a second IONEX file (rhs) or the '--nequick' option must be provided.")
+
+    if args.rhs is not None and args.nequick is not None:
+        parser.error("You cannot specify both a second IONEX file (rhs) and the '--nequick' option.")
+
+    if args.nequick_ionex is not None and args.nequick is None:
+        parser.error("Cannot output the IONEX file with the NeQuick model without the '--nequick' option.")
+
+    # Process the lhs IONEX file
+    gim_handler_lhs = gim.GimHandlerArray()
+    load(args.lhs, gim_handler=gim_handler_lhs)
+
+    # Add comments to the output file
+    comment_lines = [
+        "This IONEX file contains the differences of VTEC values,",
+        "computed as vtec_left - vtec_right, where:",
+        f"- vtec_left: {os.path.basename(args.lhs)}"
+    ]
+
+    # Process the rhs input (either an IONEX file or NeQuick coefficients)
+    gim_handler_rhs = None
+    if args.rhs:
+        gim_handler_rhs = gim.GimHandlerArray()
+        # Load the second IONEX file
+        load(args.rhs, gim_handler=gim_handler_rhs)
+        comment_lines += [f"- vtec_right: {os.path.basename(args.rhs)}"]
+
+    else:
+        gim_handler_rhs = NeQuickGimHandlerArray()
+        # Generate GIMs using NeQuick coefficients
+        coeffs = args.nequick
+        nequick_desc = ["NeQuick model", f"   az0={coeffs[0]}", f"   az1={coeffs[1]}", f"   az2={coeffs[2]}"]
+        comment_lines += [f"- vtec_right: {nequick_desc[0]}"] + nequick_desc[1:]
+
+        for ionex_gim in gim_handler_lhs.vtec_gims:
+
+            nequick.to_gim(nequick.Coefficients(*coeffs),
+                           ionex_gim.epoch,
+                           latitudes = ionex_gim.latitudes,
+                           longitudes = ionex_gim.longitudes,
+                           gim_handler= gim_handler_rhs)
+
+    # Compute the difference
+    gim_diffs = gim.subtract_gims(gim_handler_lhs.vtec_gims, gim_handler_rhs.vtec_gims)
+
+
+    # Write the result to the output file
+    write(args.output, gim_diffs, gim.GimType.TEC, pgm=PGM, comment_lines=comment_lines)
+
+    if args.nequick_ionex is not None:
+        comment_lines = [
+            "TEC values generated with the " + nequick_desc[0]
+        ] + nequick_desc[1:]
+
+        write(args.nequick_ionex, gim_handler_lhs.vtec_gims, gim.GimType.TEC, pgm=PGM,
+              comment_lines=comment_lines )

pygnss/iono/chapman.py

@@ -0,0 +1,35 @@
+"""
+Module to compute the Chapman ionospheric model.
+
+This module provides functions to compute the Chapman ionospheric model,
+which is used to estimate the electron density in the ionosphere based on
+solar zenith angle and other parameters.
+"""
+
+import numpy as np
+
+HEIGHTS_KM = np.arange(60, 1000, 10)
+
+def compute_chapman_profile(hmF2_km: float, NmF2: float, H_km: float, zenith_angle_deg: float, heights_km: float | np.ndarray =HEIGHTS_KM) -> float | np.ndarray:
+    """
+    Compute the Chapman ionospheric model.
+
+    Parameters:
+    zenith_angle (float or np.ndarray): Solar zenith angle, the angle between the vertical and the direction to the Sun.
+    hmF2_km (float): Height of the F2 layer in kilometers.
+    NmF2 (float): Peak electron density at hmF2 in electrons/m^3.
+    H_km (float): Scale height in kilometers (typical values between 30 and 50 km).
+    heights_km (np.ndarray, optional): Heights at which to compute the electron density.
+        If None, defaults to a range from 0 to 100 km.
+
+    Returns:
+    float or np.ndarray: Computed electron density based on the Chapman model.
+    """
+    # Convert zenith angle from degrees to radians
+    zenith_angle_rad = np.radians(zenith_angle_deg)
+
+    # Include scale height
+    z = (heights_km - hmF2_km) / H_km
+
+    # Compute the Chapman function
+    return NmF2 * np.exp( 0.5 * (1 - z - np.exp(-z) / np.cos(zenith_angle_rad)))

pygnss/iono/gim.py

@@ -50,8 +50,8 @@ class GimHandlerArray(GimHandler):
     """
 
     def __init__(self):
-        self.vtec_gims = []
-        self.rms_gims = []
+        self.vtec_gims: List[Gim] = []
+        self.rms_gims: List[Gim] = []
 
     def process(self, gim: Gim, type: GimType):
         """

{pygnss-0.6.0.dist-info → pygnss-1.0.0.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: pygnss
-Version: 0.6.0
+Version: 1.0.0
 Summary: Package with utilities and tools for GNSS data processing
 Author-email: Miquel Garcia-Fernandez <miquel@mgfernan.com>
 License: MIT
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: nequick
+Requires-Dist: nequick>=0.2.0
 Requires-Dist: numpy
 Requires-Dist: pandas>=2.2
 Requires-Dist: pyarrow>=18.0.0

{pygnss-0.6.0.dist-info → pygnss-1.0.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
-pygnss/__init__.py,sha256=cID1jLnC_vj48GgMN6Yb1FA3JsQ95zNmCHmRYE8TFhY,22
-pygnss/_c_ext.cpython-312-x86_64-linux-musl.so,sha256=ctqHTTBBdSAmNdjEjiY4tm7dgr5yDsZfDqepX3tb1Lc,83816
+pygnss/__init__.py,sha256=J-j-u0itpEFT6irdmWmixQqYMadNl1X91TxUmoiLHMI,22
+pygnss/_c_ext.cpython-312-x86_64-linux-musl.so,sha256=DG4vxh2TrbC-g7RuCcQAvm3zUig_pO5xcVg45l0ljUw,83816
 pygnss/cl.py,sha256=ISmd2RjikUMmj3nLPN0VSjvQLG5rLizp2X2ajeBkoDE,4509
 pygnss/constants.py,sha256=1hF6K92X6E6Ofo0rAuCBCgrwln9jxio26RV2a6vyURk,133
 pygnss/decorator.py,sha256=qB-0jl2GTEHJdvmDruNll5X3RrdySssv94u9Hok5-lA,1438
 pygnss/file.py,sha256=kkMBWjoTPkxJD1UgH0mXJT2fxnhU8u7_l2Ph5Xz2-hY,933
 pygnss/geodetic.py,sha256=3q8Rpl4b5CxGlhdn1nQRBHHSW1v-0PBFz54zOeVyO74,33633
 pygnss/hatanaka.py,sha256=P9XG6bZwUzfAPYn--6-DXfFQIEefeimE7fMJm_DF5zE,1951
-pygnss/ionex.py,sha256=Sk0U_hRyYE7cEwLyMIgiY-2bBs6wktzKmZdI92HrU7c,10422
+pygnss/ionex.py,sha256=WcY6PVwjzATjqyC0Htc5Jh_cv2a7yz4TZIcD723TpsY,14325
 pygnss/logger.py,sha256=4kvcTWXPoiG-MlyP6B330l4Fu7MfCuDjuIlIiLA8f1Y,1479
 pygnss/nequick.py,sha256=tSsUw3FoRWS-TBKKVb0_c90DFz_2jUTkUvNPsGQOLA8,1722
 pygnss/rinex.py,sha256=LsOOh3Fc263kkM8KOUBNeMeIAmbOn2ASSBO4rAUJWj8,68783
@@ -27,14 +27,15 @@ pygnss/gnss/observables.py,sha256=0x0NLkTjxf8cO9F_f_Q1b-1hEeoNjWB2x-53ecUEv0M,16
 pygnss/gnss/residuals.py,sha256=8qKGNOYkrqxHGOSjIfH21K82PAqEh2068kf78j5usL8,1244
 pygnss/gnss/types.py,sha256=lmL15KRckRiTwVkYvGzF4c1BrojnQlegrYCXSz1hGaI,10377
 pygnss/iono/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pygnss/iono/gim.py,sha256=bJ-1jRIrkZj790fuCk3np72NrPaG_Qvx-EVZsvWMfsk,3521
+pygnss/iono/chapman.py,sha256=u2XTQgEkQxhazfPGNdH5hEZ5YjPvATgMz4eIF4Adsfg,1396
+pygnss/iono/gim.py,sha256=khKzClxLf46mVO6BCDk9u9DgS_50d-sbWEyoUQu7Jng,3543
 pygnss/orbit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pygnss/orbit/kepler.py,sha256=QORTgg5yBtsQXxLWSzoZ1pmh-CwPiZlFdIYqhQhv1a0,1745
 pygnss/orbit/tle.py,sha256=6CIEielPgui3DXNv46XxOGlig31ROIwjH42xLGaeE5M,5905
 pygnss/parsers/rtklib/stats.py,sha256=YV6yadxMeQMQYZvsUCaSf4ZTpK8Bbv3f2xgu0l4PekA,5449
-pygnss-0.6.0.dist-info/METADATA,sha256=0gGj855FG6F9WGYHCsZ3gbEPX8avn7JP_P5r3QNExa4,1659
-pygnss-0.6.0.dist-info/WHEEL,sha256=ENczIf-GYPIfQ0_PXY8w5mFbOCUfjnGClbW6hbN_vLc,112
-pygnss-0.6.0.dist-info/entry_points.txt,sha256=awWUCMfX3uMIAPPZqZfSUuw7Kd7defip8L7GtthKqgg,292
-pygnss-0.6.0.dist-info/top_level.txt,sha256=oZRSR-qOv98VW2PRRMGCVNCJmewcJjyJYmxzxfeimtg,7
-pygnss-0.6.0.dist-info/RECORD,,
-pygnss-0.6.0.dist-info/licenses/LICENSE,sha256=Wwany6RAAZ9vVHjFLA9KBJ0HE77d52s2NOUA1CPAEug,1067
+pygnss-1.0.0.dist-info/METADATA,sha256=sDTBwqqNfXkPm03E0EEnHedlYv86Gwt1lc-SNlH5mOA,1666
+pygnss-1.0.0.dist-info/WHEEL,sha256=AwHYJA1Do1jwgPIoLQR4DiHSeYY_vU6Ht9Vljq5Yt_M,112
+pygnss-1.0.0.dist-info/entry_points.txt,sha256=awWUCMfX3uMIAPPZqZfSUuw7Kd7defip8L7GtthKqgg,292
+pygnss-1.0.0.dist-info/top_level.txt,sha256=oZRSR-qOv98VW2PRRMGCVNCJmewcJjyJYmxzxfeimtg,7
+pygnss-1.0.0.dist-info/RECORD,,
+pygnss-1.0.0.dist-info/licenses/LICENSE,sha256=Wwany6RAAZ9vVHjFLA9KBJ0HE77d52s2NOUA1CPAEug,1067

{pygnss-0.6.0.dist-info → pygnss-1.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (77.0.3)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: false
 Tag: cp312-cp312-musllinux_1_2_x86_64