Merge branch 'main' into derwin/ephemeris

Author: betaBison

build_docs.sh

@@ -26,6 +26,6 @@ poetry run make clean
 echo "Building docs in html"
 poetry run make html
 
-# export requirements.txt for setup.py
+# export requirements.txt for Conda environment setup
 cd ..
 poetry export -f requirements.txt --output ./requirements.txt --without-hashes

docs/source/install.rst

@@ -53,7 +53,7 @@ Editable Installation
 
           python -m pip install -U pip
 
-4. Install :code:`gnss_lib_py` locally from directory containing :code:`setup.py`
+4. Install :code:`gnss_lib_py` locally from directory containing :code:`pyproject.toml`
 
    .. code-block:: bash
 

gnss_lib_py/parsers/rinex_obs.py

@@ -20,6 +20,9 @@ class RinexObs(NavData):
     measurements from different bands are treated as separate measurement
     instances. Inherits from NavData().
 
+    This class has primarily been built with Rinex v3.05 in mind but it
+    should also work for prior Rinex versions.
+
 
     References
     ----------

notebooks/tutorials/parsers.ipynb

@@ -406,7 +406,7 @@
    "id": "fe8e8d6a",
    "metadata": {},
    "source": [
-    "## Rinex v3 Observation File Parsing"
+    "# Rinex Observation File Parsing"
    ]
   },
   {
@@ -417,8 +417,8 @@
     "Rinex is another file standard that is used in the GNSS community to store and transmit navigation information.\n",
     "Files with the extension `.yyo`, where `yy` is the year in which the measurement was made, are used to store and transmit\n",
     "measurements.\n",
-    "These measurements files can any constellation and each measurement usually contains the pseudorange, carrier phase (or difference from carrier frequency),\n",
-    "doppler, and signal-to-noise ration measurements.\n",
+    "These measurement files can contain any constellation and each measurement usually contains the pseudorange, carrier phase (or difference from carrier frequency),\n",
+    "doppler, and signal-to-noise ratio measurements.\n",
     "In the following lines, we show how to load a ``.o`` file into a NavData instance."
    ]
   },
@@ -430,8 +430,8 @@
    "outputs": [],
    "source": [
     "# download Rinex obs file and load it into NavData instance\n",
-    "!wget https://raw.githubusercontent.com/Stanford-NavLab/gnss_lib_py/ashwin/rinex-3-o/data/unit_test/rinex/obs/rinex_obs_mixed_types.20o --quiet -O \"rinex_obs_mixed_types.20o\"\n",
-    "rinex_obs_3 = glp.RinexObs3(\"rinex_obs_mixed_types.20o\")\n",
+    "!wget https://raw.githubusercontent.com/Stanford-NavLab/gnss_lib_py/main/data/unit_test/rinex/obs/rinex_obs_mixed_types.20o --quiet -O \"rinex_obs_mixed_types.20o\"\n",
+    "rinex_obs_3 = glp.RinexObs(\"rinex_obs_mixed_types.20o\")\n",
     "print('Loaded Rinex Obs 3 data for the first time instant\\n', \\\n",
     "      rinex_obs_3.where('gps_millis', rinex_obs_3['gps_millis', 0], 'eq'))"
    ]

tests/parsers/test_rinex_obs.py

@@ -9,8 +9,8 @@
 
 import pytest
 import numpy as np
-
 from pytest_lazyfixture import lazy_fixture
+
 from gnss_lib_py.parsers.rinex_obs import RinexObs
 
 @pytest.fixture(name="root_path")
@@ -104,7 +104,7 @@ def fixture_single_compare():
 
     Returns
     -------
-    single_compare : list
+    single_exp_values : list
         List of time instance, row names, gnss_sv_id and expected values
         for single case.
     """
@@ -124,7 +124,7 @@ def test_rinex_obs_3_load_single(rinex_single_values, single_exp_values):
     rinex_single_values : gnss_lib_py.parsers.rinex_obs.RinexObs
         Instance of RinexObs class with data loaded from appropriate
         file.
-    compare_values : list
+    single_exp_values : list
         List of lists containing time instance, gnss_sv_id, and expected
         value for different
         Rinex use cases.
@@ -149,10 +149,10 @@ def test_rinex_obs_3_load_mixed(rinex_mixed_values, mixed_exp_values):
 
     Parameters
     ----------
-    rinex_navdata : gnss_lib_py.parsers.rinex_obs.RinexObs
+    rinex_mixed_values : gnss_lib_py.parsers.rinex_obs.RinexObs
         Instance of RinexObs class with data loaded from appropriate
         file.
-    compare_values : list
+    mixed_exp_values : list
         List of indices and values to compare against.
     """
     count = 0
@@ -175,7 +175,7 @@ def fixture_sats_per_time_single():
 
     Returns
     -------
-    sats_per_time : list
+    sats_per_time_single : list
         List of number of satellites that are present at each time step.
     """
     sats_per_time_single = [25, 24, 24]
@@ -188,7 +188,7 @@ def fixture_sats_per_time_mixed():
 
     Returns
     -------
-    sats_per_time : list
+    sats_per_time_mixed : list
         List of number of satellites that are present at each time step.
     """
     sats_per_time_mixed = [25, 25, 26, 26, 24]
@@ -242,4 +242,4 @@ def test_rinex_obs_3_fails(rinex_mixed_values):
         assert len(sv_not_rx) == 0
         if count == 1:
             sv_not_pseudo = rinex_frame.where('gnss_sv_id', 'G29', 'eq')
-            assert len(sv_not_pseudo) == 0
+            assert len(sv_not_pseudo) == 0