Merge pull request #157 from Stanford-NavLab/v1.0.2

v1.0.2 is ready as a new release.

Author: danineamati

.github/workflows/build.yml

@@ -66,7 +66,7 @@ jobs:
     - name: Test with pytest
       run: |
         source $VENV
-        pytest --cov=gnss_lib_py/algorithms --cov=gnss_lib_py/parsers --cov=gnss_lib_py/utils --cov-report=xml
+        poetry run pytest --cov=gnss_lib_py/algorithms --cov=gnss_lib_py/navdata --cov=gnss_lib_py/parsers --cov=gnss_lib_py/utils --cov=gnss_lib_py/visualizations --cov-report=xml
     - name: Upload coverage report to code-cov
       uses: codecov/codecov-action@v3
       with:

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

@@ -59,7 +59,7 @@ Standard GitHub Workflow
 
    .. code-block:: bash
 
-      poetry run pytest --cov=gnss_lib_py/algorithms --cov=gnss_lib_py/parsers --cov=gnss_lib_py/utils --cov-report=xml
+      poetry run pytest --cov=gnss_lib_py/algorithms --cov=gnss_lib_py/navdata --cov=gnss_lib_py/parsers --cov=gnss_lib_py/utils --cov=gnss_lib_py/visualizations --cov-report=html
       poetry run coverage report
 
    See the :ref:`Coverage Report<coverage>` section for more details.
@@ -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:
-
-    .. 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. 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,
@@ -153,7 +142,7 @@ NAVLab GitHub Workflow
 
    .. code-block:: bash
 
-      poetry run pytest --cov=gnss_lib_py/algorithms --cov=gnss_lib_py/parsers --cov=gnss_lib_py/utils --cov-report=xml
+      poetry run pytest --cov=gnss_lib_py/algorithms --cov=gnss_lib_py/navdata --cov=gnss_lib_py/parsers --cov=gnss_lib_py/utils --cov=gnss_lib_py/visualizations --cov-report=html
       poetry run coverage report
 
    See the :ref:`Coverage Report<coverage>` section for more details.
@@ -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/modules.rst

@@ -0,0 +1,8 @@
+navdata
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   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: