Merge pull request #154 from Stanford-NavLab/ashwin+daniel/dop

Added DOP functionality

build_docs.sh

@@ -8,16 +8,24 @@ cd docs
 echo "Rebuilding References"
 rm -r ./source/reference/algorithms/*
 poetry run sphinx-apidoc -f -M -q -o ./source/reference/algorithms/ ./../gnss_lib_py/algorithms/
+rm -r ./source/reference/navdata/*
+poetry run sphinx-apidoc -f -M -q -o ./source/reference/navdata/ ./../gnss_lib_py/navdata/
 rm -r ./source/reference/parsers/*
 poetry run sphinx-apidoc -f -M -q -o ./source/reference/parsers/ ./../gnss_lib_py/parsers/
 rm -r ./source/reference/utils/*
 poetry run sphinx-apidoc -f -M -q -o ./source/reference/utils/ ./../gnss_lib_py/utils/
+rm -r ./source/reference/visualizations/*
+poetry run sphinx-apidoc -f -M -q -o ./source/reference/visualizations/ ./../gnss_lib_py/visualizations/
 rm -r ./source/reference/test_algorithms/*
 poetry run sphinx-apidoc -f -M -q -o ./source/reference/test_algorithms/ ./../tests/algorithms/
+rm -r ./source/reference/test_navdata/*
+poetry run sphinx-apidoc -f -M -q -o ./source/reference/test_navdata/ ./../tests/navdata/
 rm -r ./source/reference/test_parsers/*
 poetry run sphinx-apidoc -f -M -q -o ./source/reference/test_parsers/ ./../tests/parsers/
 rm -r ./source/reference/test_utils/*
 poetry run sphinx-apidoc -f -M -q -o ./source/reference/test_utils/ ./../tests/utils/
+rm -r ./source/reference/test_visualizations/*
+poetry run sphinx-apidoc -f -M -q -o ./source/reference/test_visualizations/ ./../tests/visualizations/
 
 # remove previously downloaded .csv files if they exist
 rm ./source/*/*.csv

docs/source/conf.py

@@ -22,12 +22,16 @@
 sys.path.insert(0, os.path.abspath('../../'))
 sys.path.insert(0, os.path.abspath('../../gnss_lib_py/'))
 sys.path.insert(0, os.path.abspath('../../gnss_lib_py/algorithms/'))
+sys.path.insert(0, os.path.abspath('../../gnss_lib_py/navdata/'))
 sys.path.insert(0, os.path.abspath('../../gnss_lib_py/parsers/'))
 sys.path.insert(0, os.path.abspath('../../gnss_lib_py/utils/'))
+sys.path.insert(0, os.path.abspath('../../gnss_lib_py/visualizations/'))
 sys.path.insert(0, os.path.abspath('../../tests/'))
 sys.path.insert(0, os.path.abspath('../../tests/algorithms'))
+sys.path.insert(0, os.path.abspath('../../tests/navdata'))
 sys.path.insert(0, os.path.abspath('../../tests/parsers'))
 sys.path.insert(0, os.path.abspath('../../tests/utils'))
+sys.path.insert(0, os.path.abspath('../../tests/visualizations'))
 
 
 # -- Project information -----------------------------------------------------

docs/source/contributing/development.rst

@@ -79,28 +79,17 @@ Standard GitHub Workflow
    folders for PyCharm and :code:`.vscode` folders for VS Code are not
    committed by updating the :code:`.gitignore` file.
 
-10. Improve code readability by linting it. Run :code:`pylint` to preview
-    issues with the code:
+10. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.md>`__.
 
-    .. code-block:: bash
-
-       poetry run python -m pylint path-to-file-to-lint
-
-    Resolve issues that do not impact how you have implemented your functionality,
-    such as conforming to snake case naming, removing TODOs and using suggested
-    defaults.
-
-11. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.md>`__.
-
-12. Commit your changes and publish your branch to GitHub:
+11. Commit your changes and publish your branch to GitHub:
 
    .. code-block:: bash
 
       git add -A
       git commit -m "<describe changes in this commit>"
       git push origin your-name/name-of-your-bugfix-or-feature
 
-13. Submit a pull request through GitHub. For the base branch
+12. Submit a pull request through GitHub. For the base branch
     in the pull request, select the latest version release branch :code:`vX.Y.Z`
     (with the highest number of all such branches). *Do not target the*
     :code:`main` *branch in your pull request.* In the pull request,
@@ -173,20 +162,9 @@ NAVLab GitHub Workflow
    folders for PyCharm and :code:`.vscode` folders for VS Code are not
    committed by updating the :code:`.gitignore` file.
 
-10. Improve code readability by linting it. Run :code:`pylint` to preview
-    issues with the code:
-
-    .. code-block:: bash
-
-       poetry run python -m pylint path-to-file-to-lint
-
-    Resolve issues that do not impact how you have implemented your functionality,
-    such as conforming to snake case naming, removing TODOs and using suggested
-    defaults.
-
-11. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.md>`__.
+10. Add your name to the `contributors list <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/CONTRIBUTORS.md>`__.
 
-12. When you're ready to commit changes follow the steps below to
+11. When you're ready to commit changes follow the steps below to
     minimize unnecessary merging. This is especially important if
     multiple people are working on the same branch. If you pull new
     changes, then repeat the tests above to double check that everything
@@ -201,7 +179,7 @@ NAVLab GitHub Workflow
       git commit -m "<describe changes in this commit>"
       git push origin your-name/name-of-your-bugfix-or-feature
 
-13. Submit a pull request through GitHub. For the base branch
+12. Submit a pull request through GitHub. For the base branch
     in the pull request, select the latest version release branch :code:`vX.Y.Z`
     (with the highest number of all such branches). *Do not target the*
     :code:`main` *branch in your pull request.* In the pull request,

docs/source/reference/navdata/modules.rst

@@ -0,0 +1,8 @@
+navdata
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   navdata
+   operations

docs/source/reference/navdata/navdata.rst

@@ -0,0 +1,7 @@
+navdata module
+==============
+
+.. automodule:: navdata
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/navdata/operations.rst

@@ -0,0 +1,7 @@
+operations module
+=================
+
+.. automodule:: operations
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/reference.rst

@@ -290,8 +290,10 @@ documentation below.
      :maxdepth: 2
 
      algorithms/modules
+     navdata/modules
      parsers/modules
      utils/modules
+     visualizations/modules
 
 Testing References
 --------------------------------
@@ -302,8 +304,10 @@ documentation below.
      :maxdepth: 2
 
      test_algorithms/modules
+     test_navdata/modules
      test_parsers/modules
      test_utils/modules
+     test_visualizations/modules
 
 
 Additional Indices

docs/source/reference/test_navdata/conftest.rst

@@ -0,0 +1,7 @@
+conftest module
+===============
+
+.. automodule:: conftest
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/test_navdata/modules.rst

@@ -0,0 +1,9 @@
+navdata
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   conftest
+   test_navdata
+   test_operations

docs/source/reference/test_navdata/test_navdata.rst

@@ -0,0 +1,7 @@
+test\_navdata module
+====================
+
+.. automodule:: test_navdata
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/test_navdata/test_operations.rst

@@ -0,0 +1,7 @@
+test\_operations module
+=======================
+
+.. automodule:: test_operations
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/test_utils/modules.rst

@@ -6,6 +6,7 @@ utils
 
    conftest
    test_coordinates
+   test_dop
    test_ephemeris_downloader
    test_file_operations
    test_filters

docs/source/reference/test_utils/test_dop.rst

@@ -0,0 +1,7 @@
+test\_dop module
+================
+
+.. automodule:: test_dop
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/test_visualizations/conftest.rst

@@ -0,0 +1,7 @@
+conftest module
+===============
+
+.. automodule:: conftest
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/test_visualizations/modules.rst

@@ -0,0 +1,11 @@
+visualizations
+==============
+
+.. toctree::
+   :maxdepth: 4
+
+   conftest
+   test_plot_map
+   test_plot_metric
+   test_plot_skyplot
+   test_style

docs/source/reference/test_visualizations/test_plot_map.rst

@@ -0,0 +1,7 @@
+test\_plot\_map module
+======================
+
+.. automodule:: test_plot_map
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/test_visualizations/test_plot_metric.rst

@@ -0,0 +1,7 @@
+test\_plot\_metric module
+=========================
+
+.. automodule:: test_plot_metric
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/test_visualizations/test_plot_skyplot.rst

@@ -0,0 +1,7 @@
+test\_plot\_skyplot module
+==========================
+
+.. automodule:: test_plot_skyplot
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/test_visualizations/test_style.rst

@@ -0,0 +1,7 @@
+test\_style module
+==================
+
+.. automodule:: test_style
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/utils/dop.rst

@@ -0,0 +1,7 @@
+dop module
+==========
+
+.. automodule:: dop
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/utils/modules.rst

@@ -6,6 +6,7 @@ utils
 
    constants
    coordinates
+   dop
    ephemeris_downloader
    file_operations
    filters

docs/source/reference/visualizations/modules.rst

@@ -0,0 +1,10 @@
+visualizations
+==============
+
+.. toctree::
+   :maxdepth: 4
+
+   plot_map
+   plot_metric
+   plot_skyplot
+   style

docs/source/reference/visualizations/plot_map.rst

@@ -0,0 +1,7 @@
+plot\_map module
+================
+
+.. automodule:: plot_map
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/visualizations/plot_metric.rst

@@ -0,0 +1,7 @@
+plot\_metric module
+===================
+
+.. automodule:: plot_metric
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/visualizations/plot_skyplot.rst

@@ -0,0 +1,7 @@
+plot\_skyplot module
+====================
+
+.. automodule:: plot_skyplot
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/visualizations/style.rst

@@ -0,0 +1,7 @@
+style module
+============
+
+.. automodule:: style
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/tutorials/tutorials.rst

@@ -69,6 +69,7 @@ available in the :code:`utils` directory.
 
    utils/tutorials_constants_notebook
    utils/tutorials_coordinates_notebook
+   utils/tutorials_dop_notebook
    utils/tutorials_ephemeris_downloader_notebook
    utils/tutorials_file_operations_notebook
    utils/tutorials_filters_notebook

docs/source/tutorials/utils/tutorials_dop_notebook.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../../../../notebooks/tutorials/utils/dop.ipynb"
+}

gnss_lib_py/__init__.py

@@ -22,6 +22,7 @@
 
 from gnss_lib_py.utils.constants import *
 from gnss_lib_py.utils.coordinates import *
+from gnss_lib_py.utils.dop import *
 from gnss_lib_py.utils.ephemeris_downloader import *
 from gnss_lib_py.utils.file_operations import *
 from gnss_lib_py.utils.filters import *

gnss_lib_py/utils/coordinates.py

@@ -570,3 +570,34 @@ def wrap_0_to_2pi(angles):
     angles = np.mod(angles, 2*np.pi)
 
     return angles
+
+
+def el_az_to_enu_unit_vector(el_deg, az_deg):
+    """
+    Convert elevation and azimuth to ENU unit vectors.
+    
+    Parameters
+    ----------
+    el_deg : np.ndarray
+        Elevation angle in degrees.
+        
+    az_deg : np.ndarray
+        Azimuth angle in degrees.
+        
+    Returns
+    -------
+    unit_dir_mat : np.ndarray
+        ENU unit vectors.
+    """
+    el_rad = np.deg2rad(el_deg)
+    az_rad = np.deg2rad(az_deg)
+
+    unit_dir_mat = np.vstack(
+        (np.atleast_2d(np.cos(el_rad) * np.sin(az_rad)),
+         np.atleast_2d(np.cos(el_rad) * np.cos(az_rad)),
+         np.atleast_2d(np.sin(el_rad))
+         )).T
+
+    return unit_dir_mat
+
+