Updated docstrings in sp3.py and clk.py

Author: kanhereashwin

docs/source/requirements.txt

@@ -1,6 +1,6 @@
 alabaster==0.7.13 ; python_version >= "3.8" and python_version < "3.12"
 anyio==3.7.1 ; python_version >= "3.8" and python_version < "3.12"
-appnope==0.1.3 ; python_version >= "3.8" and python_version < "3.12" and (platform_system == "Darwin" or sys_platform == "darwin")
+appnope==0.1.3 ; python_version >= "3.8" and python_version < "3.12" and platform_system == "Darwin" or python_version >= "3.8" and python_version < "3.12" and sys_platform == "darwin"
 argon2-cffi-bindings==21.2.0 ; python_version >= "3.8" and python_version < "3.12"
 argon2-cffi==21.3.0 ; python_version >= "3.8" and python_version < "3.12"
 arrow==1.2.3 ; python_version >= "3.8" and python_version < "3.12"
@@ -14,7 +14,7 @@ bleach==6.0.0 ; python_version >= "3.8" and python_version < "3.12"
 certifi==2023.7.22 ; python_version >= "3.8" and python_version < "3.12"
 cffi==1.15.1 ; python_version >= "3.8" and python_version < "3.12"
 charset-normalizer==3.2.0 ; python_version >= "3.8" and python_version < "3.12"
-colorama==0.4.6 ; python_version >= "3.8" and python_version < "3.12" and (sys_platform == "win32" or platform_system == "Windows")
+colorama==0.4.6 ; python_version >= "3.8" and python_version < "3.12" and sys_platform == "win32" or python_version >= "3.8" and python_version < "3.12" and platform_system == "Windows"
 comm==0.1.4 ; python_version >= "3.8" and python_version < "3.12"
 contourpy==1.1.0 ; python_version >= "3.8" and python_version < "3.12"
 coverage[toml]==7.2.7 ; python_version >= "3.8" and python_version < "3.12"
@@ -77,7 +77,7 @@ ncompress==1.0.1 ; python_version >= "3.8" and python_version < "3.12"
 nest-asyncio==1.5.7 ; python_version >= "3.8" and python_version < "3.12"
 notebook-shim==0.2.3 ; python_version >= "3.8" and python_version < "3.12"
 notebook==6.5.5 ; python_version >= "3.8" and python_version < "3.12"
-numpy==1.24.4 ; python_version >= "3.8" and python_version < "3.12"
+numpy==1.24.4 ; python_version < "3.12" and python_version >= "3.8"
 overrides==7.3.1 ; python_version >= "3.8" and python_version < "3.12"
 packaging==23.1 ; python_version >= "3.8" and python_version < "3.12"
 pandas==2.0.3 ; python_version >= "3.8" and python_version < "3.12"
@@ -94,7 +94,7 @@ pockets==0.9.1 ; python_version >= "3.8" and python_version < "3.12"
 prometheus-client==0.17.1 ; python_version >= "3.8" and python_version < "3.12"
 prompt-toolkit==3.0.39 ; python_version >= "3.8" and python_version < "3.12"
 psutil==5.9.5 ; python_version >= "3.8" and python_version < "3.12"
-ptyprocess==0.7.0 ; python_version >= "3.8" and python_version < "3.12" and (os_name != "nt" or sys_platform != "win32")
+ptyprocess==0.7.0 ; python_version >= "3.8" and python_version < "3.12" and os_name != "nt" or python_version >= "3.8" and python_version < "3.12" and sys_platform != "win32"
 pure-eval==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
 py==1.11.0 ; python_version >= "3.8" and python_version < "3.12" and implementation_name == "pypy"
 pycparser==2.21 ; python_version >= "3.8" and python_version < "3.12"
@@ -141,7 +141,7 @@ stack-data==0.6.2 ; python_version >= "3.8" and python_version < "3.12"
 tenacity==8.2.2 ; python_version >= "3.8" and python_version < "3.12"
 terminado==0.17.1 ; python_version >= "3.8" and python_version < "3.12"
 tinycss2==1.2.1 ; python_version >= "3.8" and python_version < "3.12"
-tomli==2.0.1 ; python_version >= "3.8" and python_version < "3.11"
+tomli==2.0.1 ; python_version >= "3.8" and python_full_version <= "3.11.0a6"
 tomlkit==0.12.1 ; python_version >= "3.8" and python_version < "3.12"
 tornado==6.3.2 ; python_version >= "3.8" and python_version < "3.12"
 tqdm==4.65.0 ; python_version >= "3.8" and python_version < "3.12"

gnss_lib_py/parsers/clk.py

@@ -1,4 +1,4 @@
-"""Functions to process .clk and .CLK precise clock product files.
+"""Functions to process .clk precise clock product files.
 
 """
 
@@ -112,16 +112,18 @@ def extract_clk(self, gnss_sv_id, sidx, ipos = 10, \
         Parameters
         ----------
         gnss_sv_id : string
-            PRN of satellite for which position should be determined.
+            Constellations and SV id of satellite for which position is
+            to be determined.
+            See standard nomenclature reference for more details.
         sidx : int
             Nearest index within clk time series around which interpolated
-            function needs to be centered
+            function needs to be centered.
         ipos : int
             No. of data points from clk data on either side of sidx
-            that will be used for computing interpolated function
+            that will be used for computing interpolated function.
         method : string
             Type of interpolation method used for clk data (the default is
-            CubicSpline, which depicts third-order polynomial)
+            CubicSpline, which depicts third-order polynomial).
         verbose : bool
             If true, prints extra debugging statements.
 

gnss_lib_py/parsers/sp3.py

@@ -1,4 +1,4 @@
-"""Functions to process .sp3 or .SP3 precise orbit files.
+"""Functions to process .sp3 precise orbit files.
 
 """
 
@@ -18,12 +18,12 @@
 
 
 class Sp3(NavData):
-    """sp3 specific loading and preprocessing for any GNSS constellation
+    """sp3 specific loading and preprocessing for any GNSS constellation.
 
     Parameters
     ----------
     input_path : string or path-like
-        Path to sp3 file
+        Path to sp3 file.
 
     Notes
     -----
@@ -112,13 +112,13 @@ def extract_sp3(self, gnss_sv_id, sidx, ipos = 10, \
             PRN of satellite for which position should be determined.
         sidx : int
             Nearest index within sp3 time series around which interpolated
-            function needs to be centered
+            function needs to be centered.
         ipos : int
             No. of data points from sp3 data on either side of sidx
-            that will be used for computing interpolated function
+            that will be used for computing interpolated function.
         method : string
             Type of interpolation method used for sp3 data (the default is
-            CubicSpline, which depicts third-order polynomial)
+            CubicSpline, which depicts third-order polynomial).
         verbose : bool
             If true, prints extra debugging statements.
 
@@ -164,16 +164,16 @@ def sp3_snapshot(self, func_satpos, cxtime, hstep = 5e-1,
         ----------
         func_satpos : np.ndarray
             Instance with 3-D array of scipy.interpolate.interpolate.interp1d
-            that is loaded with .sp3 data
+            that is loaded with .sp3 data.
         cxtime : float
             Time at which the satellite 3-D position and velocity needs to be
-            computed, given 3-D array of interpolated functions
+            computed, given 3-D array of interpolated functions.
         hstep : float
             Step size in milliseconds used to computing 3-D velocity of any
-            given satellite using central differencing the default is 5e-1)
+            given satellite using central differencing the default is 5e-1).
         method : string
             Type of interpolation method used for sp3 data (the default is
-            CubicSpline, which depicts third-order polynomial)
+            CubicSpline, which depicts third-order polynomial).
 
         Returns
         -------

requirements.txt

@@ -1,5 +1,5 @@
 anyio==3.7.1 ; python_version >= "3.8" and python_version < "3.12"
-appnope==0.1.3 ; python_version >= "3.8" and python_version < "3.12" and (platform_system == "Darwin" or sys_platform == "darwin")
+appnope==0.1.3 ; python_version >= "3.8" and python_version < "3.12" and platform_system == "Darwin" or python_version >= "3.8" and python_version < "3.12" and sys_platform == "darwin"
 argon2-cffi-bindings==21.2.0 ; python_version >= "3.8" and python_version < "3.12"
 argon2-cffi==21.3.0 ; python_version >= "3.8" and python_version < "3.12"
 arrow==1.2.3 ; python_version >= "3.8" and python_version < "3.12"
@@ -71,7 +71,7 @@ ncompress==1.0.1 ; python_version >= "3.8" and python_version < "3.12"
 nest-asyncio==1.5.7 ; python_version >= "3.8" and python_version < "3.12"
 notebook-shim==0.2.3 ; python_version >= "3.8" and python_version < "3.12"
 notebook==6.5.5 ; python_version >= "3.8" and python_version < "3.12"
-numpy==1.24.4 ; python_version >= "3.8" and python_version < "3.12"
+numpy==1.24.4 ; python_version < "3.12" and python_version >= "3.8"
 overrides==7.3.1 ; python_version >= "3.8" and python_version < "3.12"
 packaging==23.1 ; python_version >= "3.8" and python_version < "3.12"
 pandas==2.0.3 ; python_version >= "3.8" and python_version < "3.12"
@@ -87,7 +87,7 @@ pluggy==1.2.0 ; python_version >= "3.8" and python_version < "3.12"
 prometheus-client==0.17.1 ; python_version >= "3.8" and python_version < "3.12"
 prompt-toolkit==3.0.39 ; python_version >= "3.8" and python_version < "3.12"
 psutil==5.9.5 ; python_version >= "3.8" and python_version < "3.12"
-ptyprocess==0.7.0 ; python_version >= "3.8" and python_version < "3.12" and (os_name != "nt" or sys_platform != "win32")
+ptyprocess==0.7.0 ; python_version >= "3.8" and python_version < "3.12" and os_name != "nt" or python_version >= "3.8" and python_version < "3.12" and sys_platform != "win32"
 pure-eval==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
 py==1.11.0 ; python_version >= "3.8" and python_version < "3.12" and implementation_name == "pypy"
 pycparser==2.21 ; python_version >= "3.8" and python_version < "3.12"
@@ -123,7 +123,7 @@ stack-data==0.6.2 ; python_version >= "3.8" and python_version < "3.12"
 tenacity==8.2.2 ; python_version >= "3.8" and python_version < "3.12"
 terminado==0.17.1 ; python_version >= "3.8" and python_version < "3.12"
 tinycss2==1.2.1 ; python_version >= "3.8" and python_version < "3.12"
-tomli==2.0.1 ; python_version >= "3.8" and python_version < "3.11"
+tomli==2.0.1 ; python_version >= "3.8" and python_full_version <= "3.11.0a6"
 tomlkit==0.12.1 ; python_version >= "3.8" and python_version < "3.12"
 tornado==6.3.2 ; python_version >= "3.8" and python_version < "3.12"
 traitlets==5.9.0 ; python_version >= "3.8" and python_version < "3.12"