docstring edits

Author: betaBison

gnss_lib_py/parsers/clk.py

@@ -1,4 +1,4 @@
-"""Functions to process precise ephemerides .sp3 and .clk files.
+"""Functions to process .clk and .CLK precise clock product files.
 
 """
 
@@ -32,20 +32,27 @@ class Clk(NavData):
 
     Notes
     -----
-    The format for .clk files can be viewed in [2]_.
+    The format for .clk files can be viewed in [1]_.
 
     Based on code written by J. Makela.
     AE 456, Global Navigation Sat Systems, University of Illinois
     Urbana-Champaign. Fall 2015
 
     References
     -----
-    .. [2]  https://files.igs.org/pub/data/format/rinex_clock300.txt
+    .. [1]  https://files.igs.org/pub/data/format/rinex_clock300.txt
             Accessed as of August 24, 2022
 
     """
     def __init__(self, input_path):
+        """Clk loading and preprocessing.
 
+        Parameters
+        ----------
+        input_path : string or path-like
+            Path to clk file
+
+        """
         super().__init__()
 
         gps_millis = []
@@ -115,6 +122,8 @@ def extract_clk(self, gnss_sv_id, sidx, ipos = 10, \
         method : string
             Type of interpolation method used for clk data (the default is
             CubicSpline, which depicts third-order polynomial)
+        verbose : bool
+            If true, prints extra debugging statements.
 
         Returns
         -------
@@ -139,7 +148,8 @@ def extract_clk(self, gnss_sv_id, sidx, ipos = 10, \
         return func_satbias
 
 
-    def clk_snapshot(self, func_satbias, cxtime, hstep = 5e-1, method='CubicSpline'):
+    def clk_snapshot(self, func_satbias, cxtime, hstep = 5e-1,
+                     method='CubicSpline'):
         """Compute satellite clock bias and drift from clk interpolated function
 
         Parameters

gnss_lib_py/parsers/nmea.py

@@ -21,7 +21,7 @@ class Nmea(NavData):
     """Class used to parse through NMEA files
 
     """
-    def __init__(self, filename, msg_types=None,
+    def __init__(self, input_path, msg_types=None,
                  check=False, keep_raw=False, include_ecef=False):
         """Read instance of NMEA file following NMEA 0183 standard.
 
@@ -32,7 +32,7 @@ def __init__(self, filename, msg_types=None,
 
         Parameters
         ----------
-        filename : str or path-like
+        input_path : str or path-like
             filepath to NMEA file to read.
         msg_types : list
             List of strings describing messages that can be parsed.
@@ -65,12 +65,12 @@ def __init__(self, filename, msg_types=None,
         field_dict = {}
         prev_timestamp = None
 
-        if not isinstance(filename, (str, os.PathLike)):
-            raise TypeError("filename must be string or path-like")
-        if not os.path.exists(filename):
+        if not isinstance(input_path, (str, os.PathLike)):
+            raise TypeError("input_path must be string or path-like")
+        if not os.path.exists(input_path):
             raise FileNotFoundError("file not found")
 
-        with open(filename, "r", encoding='UTF-8') as open_file:
+        with open(input_path, "r", encoding='UTF-8') as open_file:
             for line in open_file:
                 check_ind = line.find('*')
                 if not check and '*' in line:

gnss_lib_py/parsers/rinex_nav.py

@@ -1,25 +1,11 @@
 """Parses Rinex .n files.
-#TODO: Remove this description and move to the tutorials and description
-#in the documentation
-The Ephemeris Manager provides broadcast ephemeris for specific
-satellites at a specific timestep. The EphemerisDownloader class should be
-initialized and then the ``get_ephemeris`` function can be used to
-retrieve ephemeris for specific satellites. ``get_ephemeris`` returns
-the most recent broadcast ephemeris for the provided list of satellites
-that was broadcast BEFORE the provided timestamp. For example GPS daily
-ephemeris files contain data at a two hour frequency, so if the
-timestamp provided is 5am, then ``get_ephemeris`` will return the 4am
-data but not 6am. If provided a timestamp between midnight and 2am then
-the ephemeris from around midnight (might be the day before) will be
-provided. If no list of satellites is provided, then ``get_ephemeris``
-will return data for all satellites.
-
-When multiple observations are provided for the same satellite and same
-timestep, the Ephemeris Manager will only return the first instance.
-This is applicable when requesting ephemeris for multi-GNSS for the
-current day. Same-day multi GNSS data is pulled from  same day. For
-same-day multi-GNSS from https://igs.org/data/ which often has multiple
-observations.
+
+Loads rinex navigation files into a NavData object. Loading time can be
+sped up significantly by passing in the "satellites" parameter which in
+turn gets passed into the georinex library used to parse the rinex file.
+
+Rinex files can be downloaded with the load_ephemeris function in the
+utils/ephemeris_downloader.py file.
 
 """
 
@@ -28,8 +14,8 @@
 __date__ = "13 July 2021"
 
 import os
-from datetime import timezone
 import warnings
+from datetime import timezone
 
 import numpy as np
 import pandas as pd
@@ -42,28 +28,13 @@
 
 
 class RinexNav(NavData):
-    """Class to handle Rinex files containing SV parameters.
+    """Class to parse Rinex navigation files containing SV parameters.
 
-    The Ephemeris Manager provides broadcast ephemeris for specific
-    satellites at a specific timestep. The EphemerisDownloader class
-    should be initialized and then the ``get_ephemeris`` function
-    can be used to retrieve ephemeris for specific satellites.
-    ``get_ephemeris`` returns the most recent broadcast ephemeris
-    for the provided list of satellites that was broadcast BEFORE
-    the provided timestamp. For example GPS daily ephemeris files
-    contain data at a two hour frequency, so if the timestamp
-    provided is 5am, then ``get_ephemeris`` will return the 4am data
-    but not 6am. If provided a timestamp between midnight and 2am
-    then the ephemeris from around midnight (might be the day
-    before) will be provided. If no list of satellites is provided,
-    then ``get_ephemeris`` will return data for all satellites.
 
-    When multiple observations are provided for the same satellite
-    and same timestep, the Ephemeris Manager will only return the
-    first instance. This is applicable when requesting ephemeris for
-    multi-GNSS for the current day. Same-day multi GNSS data is
-    pulled from  same day. For same-day multi-GNSS from
-    https://igs.org/data/ which often has multiple observations.
+    Loads rinex navigation files into a NavData object. Loading time can
+    be sped up significantly by passing in the "satellites" parameter
+    which in turn gets passed into the georinex library used to parse
+    the rinex file.
 
     Inherits from NavData().
 
@@ -214,14 +185,16 @@ def _get_ephemeris_dataframe(self, rinex_path, constellations=None):
         ----------
         rinex_path : string or path-like
             Filepath to rinex file
-
-        constellations : Set
+        constellations : set
             Set of satellites {"ConstIDSVID"}
 
         Returns
         -------
         data : pd.DataFrame
             Parsed ephemeris DataFrame
+        data_header : dict
+            Header information from Rinex file.
+
         """
 
         if constellations is not None:
@@ -258,7 +231,7 @@ def get_iono_params(self, rinex_header, constellations=None):
 
         Parameters
         ----------
-        rinex_head : dict
+        rinex_header : dict
             Dictionary containing RINEX file header information
         constellations : list
             List of strings indicating which constellations ionosphere
@@ -325,6 +298,15 @@ def get_iono_params(self, rinex_header, constellations=None):
 
     @staticmethod
     def _iono_corr_key():
+        """Correlations between satellite name and iono param name.
+
+        Returns
+        -------
+        iono_corr_key : list
+            String names for ionospheric correction parameters within
+            the rinex navigation file.
+
+        """
         iono_corr_key = {}
         iono_corr_key['gps'] = ['GPSA', 'GPSB']
         iono_corr_key['galileo'] = ['GAL']
@@ -339,7 +321,7 @@ def load_leapseconds(self, rinex_header):
         Parameters
         ----------
         rinex_header : dict
-            Header information from Rinex file
+            Header information from Rinex file.
 
         Returns
         -------
@@ -513,12 +495,14 @@ def get_time_cropped_rinex(gps_millis, satellites=None,
         List of satellite IDs as a string, for example ['G01','E11',
         'R06']. Defaults to None which returns get_ephemeris for
         all satellites.
+    ephemeris_directory : string or path-like
+        Directory where ephemeris files are downloaded if necessary.
     verbose : bool
         Prints extra debugging statements.
 
     Returns
     -------
-    data : gnss_lib_py.parsers.navdata.NavData
+    rinex_data : gnss_lib_py.parsers.navdata.NavData
         ephemeris entries corresponding to timestamp
 
     Notes

gnss_lib_py/parsers/rinex_obs.py

@@ -1,14 +1,15 @@
 """Parses Rinex .o files"""
 
+__authors__ = "Ashwin Kanhere"
+__date__ = "26 July 2023"
+
 import numpy as np
 import georinex as gr
 
 from gnss_lib_py.parsers.navdata import NavData
 import gnss_lib_py.utils.constants as consts
 from gnss_lib_py.utils.time_conversions import datetime_to_gps_millis
 
-__authors__ = "Ashwin Kanhere"
-__date__ = "26 July 2023"
 
 class RinexObs(NavData):
     """Class handling Rinex observation files [1]_.
@@ -30,7 +31,7 @@ class RinexObs(NavData):
 
 
     """
-#TODO: Add support for selecting constellations and bands
+    #TODO: Add support for selecting constellations and bands
     def __init__(self, input_path):
         """Loading Rinex observation files into a NavData based class.
 

gnss_lib_py/parsers/sp3.py

@@ -1,4 +1,4 @@
-"""Functions to process precise ephemerides .sp3 and .clk files.
+"""Functions to process .sp3 or .SP3 precise orbit files.
 
 """
 
@@ -119,6 +119,8 @@ def extract_sp3(self, gnss_sv_id, sidx, ipos = 10, \
         method : string
             Type of interpolation method used for sp3 data (the default is
             CubicSpline, which depicts third-order polynomial)
+        verbose : bool
+            If true, prints extra debugging statements.
 
         Returns
         -------
@@ -152,8 +154,11 @@ def extract_sp3(self, gnss_sv_id, sidx, ipos = 10, \
         return func_satpos
 
 
-    def sp3_snapshot(self, func_satpos, cxtime, hstep = 5e-1, method='CubicSpline'):
-        """Compute satellite 3-D position and velocity from sp3 interpolated function
+    def sp3_snapshot(self, func_satpos, cxtime, hstep = 5e-1,
+                     method='CubicSpline'):
+        """Compute satellite 3D position and velocity.
+
+        Computes from the sp3 interpolated function.
 
         Parameters
         ----------