Merge pull request #149 from Stanford-NavLab/v1.0.0

V1.0.0
Stanford-NavLab · Jan 19, 2024 · ead1f77 · ead1f77
2 parents b84728d + 7b5bb11
commit ead1f77
Show file tree

Hide file tree

Showing 130 changed files with 6,327 additions and 5,226 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,7 +21,7 @@ results/*
 # ignore downloaded csv files in notebook tutorials
 *.csv
 !data/unit_test/**/*.csv
-!notebooks/tutorials/myreceiver.csv
+!notebooks/tutorials/data/myreceiver.csv
 
 # ignore txt files in notebook tutorials
 *.txt

diff --git a/README.md b/README.md
@@ -47,16 +47,20 @@ Code Organization
    ├── docs/                          # Documentation files
    ├── gnss_lib_py/                   # gnss_lib_py source files
         ├── algorithms/               # Navigation algorithms
+        ├── navdata/                  # NavData data structure
         ├── parsers/                  # Data parsers
         ├── utils/                    # GNSS and common utilities
+        ├── visualizations/           # plotting functions
         └── __init__.py
    ├── notebooks/                     # Interactive Jupyter notebooks
         ├── tutorials/                # Notebooks with tutorial code
    ├── results/                       # Location for result images/files
    ├── tests/                         # Tests for source files
       ├── algorithms/                 # Tests for files in algorithms
+      ├── navdata/                    # Tests for files in navdata
       ├── parsers/                    # Tests for files in parsers
       ├── utils/                      # Tests for files in utils
+      ├── visualizations/             # Tests for files in visualizations
       └── test_gnss_lib_py.py         # High level checks for repository
    ├── CONTRIBUTORS.md                # List of contributors
    ├── build_docs.sh                  # Bash script to build docs

diff --git a/docs/source/contributing/documentation.rst b/docs/source/contributing/documentation.rst
@@ -59,7 +59,7 @@ following:
       single axis arrays should be rows and time should be across
       the columns
     * :code:`pd.DataFrame`
-    * :code:`gnss_lib_py.parsers.NavData`
+    * :code:`gnss_lib_py.navdata.navdata.NavData`
 
 PEP 8 Style Guide
 -----------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -57,16 +57,20 @@ Code Organization
    ├── docs/                          # Documentation files
    ├── gnss_lib_py/                   # gnss_lib_py source files
         ├── algorithms/               # Navigation algorithms
+        ├── navdata/                  # NavData data structure
         ├── parsers/                  # Data parsers
         ├── utils/                    # GNSS and common utilities
+        ├── visualizations/           # plotting functions
         └── __init__.py
    ├── notebooks/                     # Interactive Jupyter notebooks
         ├── tutorials/                # Notebooks with tutorial code
    ├── results/                       # Location for result images/files
    ├── tests/                         # Tests for source files
       ├── algorithms/                 # Tests for files in algorithms
+      ├── navdata/                    # Tests for files in navdata
       ├── parsers/                    # Tests for files in parsers
       ├── utils/                      # Tests for files in utils
+      ├── visualizations/             # Tests for files in visualizations
       └── test_gnss_lib_py.py         # High level checks for repository
    ├── CONTRIBUTORS.md                # List of contributors
    ├── build_docs.sh                  # Bash script to build docs

diff --git a/docs/source/reference/parsers/modules.rst b/docs/source/reference/parsers/modules.rst
@@ -7,7 +7,6 @@ parsers
    android
    clk
    google_decimeter
-   navdata
    nmea
    rinex_nav
    rinex_obs

diff --git a/docs/source/reference/parsers/navdata.rst b/docs/source/reference/parsers/navdata.rst
diff --git a/docs/source/reference/reference.rst b/docs/source/reference/reference.rst
@@ -49,22 +49,6 @@ their use in ``gnss_lib_py``.
     retrieved on 27th June, 2023): for determining GLOASS SV states from
     broadcast satellite positions, velocities, and accelerations.
 
-Package Architecture
---------------------
-
-The gnss_lib_py package is broadly divided into the following sections.
-Please choose the most appropriate location based on the descriptions
-below when adding new features or functionality.
-
-* :code:`algorithms` : This directory contains localization algorithms.
-* :code:`parsers` : This directory contains functions to read and process various
-  GNSS data/file types.
-* :code:`utils` : This directory contains utilities used to handle
-  GNSS measurements, time conversions, visualizations, satellite
-  simulation, file operations, etc.
-
-More information about currently available methods and the folder
-organization can be found in the :ref:`organization subsection <organization>`.
 
 Details about NavData Class
 ---------------------------

diff --git a/docs/source/reference/test_parsers/modules.rst b/docs/source/reference/test_parsers/modules.rst
@@ -7,7 +7,6 @@ parsers
    test_android
    test_clk
    test_google_decimeter
-   test_navdata
    test_nmea
    test_rinex_nav
    test_rinex_obs

diff --git a/docs/source/reference/test_parsers/test_navdata.rst b/docs/source/reference/test_parsers/test_navdata.rst
diff --git a/docs/source/reference/test_utils/modules.rst b/docs/source/reference/test_utils/modules.rst
@@ -12,4 +12,3 @@ utils
    test_gnss_models
    test_sv_models
    test_time_conversions
-   test_visualizations
diff --git a/docs/source/reference/test_utils/test_visualizations.rst b/docs/source/reference/test_utils/test_visualizations.rst
diff --git a/docs/source/reference/utils/modules.rst b/docs/source/reference/utils/modules.rst
@@ -12,4 +12,3 @@ utils
    gnss_models
    sv_models
    time_conversions
-   visualizations
diff --git a/docs/source/reference/utils/visualizations.rst b/docs/source/reference/utils/visualizations.rst
diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -1,129 +1,127 @@
 alabaster==0.7.13 ; python_version >= "3.8" and python_version < "3.12"
-anyio==4.0.0 ; python_version >= "3.8" and python_version < "3.12"
+anyio==4.2.0 ; 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")
 argon2-cffi-bindings==21.2.0 ; python_version >= "3.8" and python_version < "3.12"
 argon2-cffi==23.1.0 ; python_version >= "3.8" and python_version < "3.12"
 arrow==1.3.0 ; python_version >= "3.8" and python_version < "3.12"
 astroid==2.15.8 ; python_version >= "3.8" and python_version < "3.12"
 asttokens==2.4.1 ; python_version >= "3.8" and python_version < "3.12"
 async-lru==2.0.4 ; python_version >= "3.8" and python_version < "3.12"
-attrs==23.1.0 ; python_version >= "3.8" and python_version < "3.12"
-babel==2.13.1 ; python_version >= "3.8" and python_version < "3.12"
+attrs==23.2.0 ; python_version >= "3.8" and python_version < "3.12"
+babel==2.14.0 ; python_version >= "3.8" and python_version < "3.12"
 backcall==0.2.0 ; python_version >= "3.8" and python_version < "3.12"
-beautifulsoup4==4.12.2 ; python_version >= "3.8" and python_version < "3.12"
+beautifulsoup4==4.12.3 ; python_version >= "3.8" and python_version < "3.12"
 bleach==6.1.0 ; python_version >= "3.8" and python_version < "3.12"
-certifi==2023.7.22 ; python_version >= "3.8" and python_version < "3.12"
+certifi==2023.11.17 ; python_version >= "3.8" and python_version < "3.12"
 cffi==1.16.0 ; python_version >= "3.8" and python_version < "3.12"
 charset-normalizer==3.3.2 ; 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")
-comm==0.2.0 ; python_version >= "3.8" and python_version < "3.12"
+comm==0.2.1 ; python_version >= "3.8" and python_version < "3.12"
 contourpy==1.1.1 ; python_version >= "3.8" and python_version < "3.12"
-coverage[toml]==7.3.2 ; python_version >= "3.8" and python_version < "3.12"
+coverage[toml]==7.4.0 ; python_version >= "3.8" and python_version < "3.12"
 cycler==0.12.1 ; python_version >= "3.8" and python_version < "3.12"
 debugpy==1.8.0 ; python_version >= "3.8" and python_version < "3.12"
 decorator==5.1.1 ; python_version >= "3.8" and python_version < "3.12"
 defusedxml==0.7.1 ; python_version >= "3.8" and python_version < "3.12"
 dill==0.3.7 ; python_version >= "3.8" and python_version < "3.12"
 docutils==0.18.1 ; python_version >= "3.8" and python_version < "3.12"
-exceptiongroup==1.1.3 ; python_version >= "3.8" and python_version < "3.11"
+exceptiongroup==1.2.0 ; python_version >= "3.8" and python_version < "3.11"
 executing==2.0.1 ; python_version >= "3.8" and python_version < "3.12"
-fastjsonschema==2.19.0 ; python_version >= "3.8" and python_version < "3.12"
-fonttools==4.44.3 ; python_version >= "3.8" and python_version < "3.12"
+fastjsonschema==2.19.1 ; python_version >= "3.8" and python_version < "3.12"
+fonttools==4.47.2 ; python_version >= "3.8" and python_version < "3.12"
 fqdn==1.5.1 ; python_version >= "3.8" and python_version < "3.12"
 georinex==1.16.1 ; python_version >= "3.8" and python_version < "3.12"
 hatanaka==2.8.1 ; python_version >= "3.8" and python_version < "3.12"
-idna==3.4 ; python_version >= "3.8" and python_version < "3.12"
+idna==3.6 ; python_version >= "3.8" and python_version < "3.12"
 imagesize==1.4.1 ; python_version >= "3.8" and python_version < "3.12"
-importlib-metadata==6.8.0 ; python_version >= "3.8" and python_version < "3.10"
+importlib-metadata==7.0.1 ; python_version >= "3.8" and python_version < "3.10"
 importlib-resources==6.1.1 ; python_version >= "3.8" and python_version < "3.12"
 iniconfig==2.0.0 ; python_version >= "3.8" and python_version < "3.12"
-ipykernel==6.26.0 ; python_version >= "3.8" and python_version < "3.12"
+ipykernel==6.29.0 ; python_version >= "3.8" and python_version < "3.12"
 ipython==8.12.3 ; python_version >= "3.8" and python_version < "3.12"
 ipywidgets==8.1.1 ; python_version >= "3.8" and python_version < "3.12"
 isoduration==20.11.0 ; python_version >= "3.8" and python_version < "3.12"
-isort==5.12.0 ; python_version >= "3.8" and python_version < "3.12"
+isort==5.13.2 ; python_version >= "3.8" and python_version < "3.12"
 jedi==0.19.1 ; python_version >= "3.8" and python_version < "3.12"
-jinja2==3.1.2 ; python_version >= "3.8" and python_version < "3.12"
+jinja2==3.1.3 ; python_version >= "3.8" and python_version < "3.12"
 json5==0.9.14 ; python_version >= "3.8" and python_version < "3.12"
 jsonpointer==2.4 ; python_version >= "3.8" and python_version < "3.12"
-jsonschema-specifications==2023.11.1 ; python_version >= "3.8" and python_version < "3.12"
-jsonschema==4.20.0 ; python_version >= "3.8" and python_version < "3.12"
-jsonschema[format-nongpl]==4.20.0 ; python_version >= "3.8" and python_version < "3.12"
+jsonschema-specifications==2023.12.1 ; python_version >= "3.8" and python_version < "3.12"
+jsonschema==4.21.1 ; python_version >= "3.8" and python_version < "3.12"
+jsonschema[format-nongpl]==4.21.1 ; python_version >= "3.8" and python_version < "3.12"
 jupyter-client==8.6.0 ; python_version >= "3.8" and python_version < "3.12"
 jupyter-console==6.6.3 ; python_version >= "3.8" and python_version < "3.12"
-jupyter-core==5.5.0 ; python_version >= "3.8" and python_version < "3.12"
+jupyter-core==5.7.1 ; python_version >= "3.8" and python_version < "3.12"
 jupyter-events==0.9.0 ; python_version >= "3.8" and python_version < "3.12"
-jupyter-lsp==2.2.0 ; python_version >= "3.8" and python_version < "3.12"
-jupyter-server-terminals==0.4.4 ; python_version >= "3.8" and python_version < "3.12"
-jupyter-server==2.10.1 ; python_version >= "3.8" and python_version < "3.12"
+jupyter-lsp==2.2.2 ; python_version >= "3.8" and python_version < "3.12"
+jupyter-server-terminals==0.5.1 ; python_version >= "3.8" and python_version < "3.12"
+jupyter-server==2.12.5 ; python_version >= "3.8" and python_version < "3.12"
 jupyter==1.0.0 ; python_version >= "3.8" and python_version < "3.12"
-jupyterlab-pygments==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
-jupyterlab-server==2.25.1 ; python_version >= "3.8" and python_version < "3.12"
+jupyterlab-pygments==0.3.0 ; python_version >= "3.8" and python_version < "3.12"
+jupyterlab-server==2.25.2 ; python_version >= "3.8" and python_version < "3.12"
 jupyterlab-widgets==3.0.9 ; python_version >= "3.8" and python_version < "3.12"
-jupyterlab==4.0.8 ; python_version >= "3.8" and python_version < "3.12"
+jupyterlab==4.0.11 ; python_version >= "3.8" and python_version < "3.12"
 kaleido==0.2.1 ; python_version >= "3.8" and python_version < "3.12"
 kiwisolver==1.4.5 ; python_version >= "3.8" and python_version < "3.12"
-lazy-object-proxy==1.9.0 ; python_version >= "3.8" and python_version < "3.12"
+lazy-object-proxy==1.10.0 ; python_version >= "3.8" and python_version < "3.12"
 markupsafe==2.1.3 ; python_version >= "3.8" and python_version < "3.12"
 matplotlib-inline==0.1.6 ; python_version >= "3.8" and python_version < "3.12"
-matplotlib==3.7.3 ; python_version >= "3.8" and python_version < "3.12"
+matplotlib==3.7.4 ; python_version >= "3.8" and python_version < "3.12"
 mccabe==0.7.0 ; python_version >= "3.8" and python_version < "3.12"
 mistune==3.0.2 ; python_version >= "3.8" and python_version < "3.12"
 nbclient==0.9.0 ; python_version >= "3.8" and python_version < "3.12"
-nbconvert==7.11.0 ; python_version >= "3.8" and python_version < "3.12"
+nbconvert==7.14.2 ; python_version >= "3.8" and python_version < "3.12"
 nbformat==5.9.2 ; python_version >= "3.8" and python_version < "3.12"
 nbsphinx-link==1.3.0 ; python_version >= "3.8" and python_version < "3.12"
 nbsphinx==0.8.12 ; python_version >= "3.8" and python_version < "3.12"
 ncompress==1.0.1 ; python_version >= "3.8" and python_version < "3.12"
-nest-asyncio==1.5.8 ; python_version >= "3.8" and python_version < "3.12"
+nest-asyncio==1.5.9 ; python_version >= "3.8" and python_version < "3.12"
 notebook-shim==0.2.3 ; python_version >= "3.8" and python_version < "3.12"
-notebook==7.0.6 ; python_version >= "3.8" and python_version < "3.12"
+notebook==7.0.7 ; python_version >= "3.8" and python_version < "3.12"
 numpy==1.24.4 ; python_version >= "3.8" and python_version < "3.12"
 overrides==7.4.0 ; python_version >= "3.8" and python_version < "3.12"
 packaging==23.2 ; python_version >= "3.8" and python_version < "3.12"
 pandas==2.0.3 ; python_version >= "3.8" and python_version < "3.12"
-pandocfilters==1.5.0 ; python_version >= "3.8" and python_version < "3.12"
+pandocfilters==1.5.1 ; python_version >= "3.8" and python_version < "3.12"
 parso==0.8.3 ; python_version >= "3.8" and python_version < "3.12"
-pexpect==4.8.0 ; python_version >= "3.8" and python_version < "3.12" and sys_platform != "win32"
+pexpect==4.9.0 ; python_version >= "3.8" and python_version < "3.12" and sys_platform != "win32"
 pickleshare==0.7.5 ; python_version >= "3.8" and python_version < "3.12"
-pillow==10.1.0 ; python_version >= "3.8" and python_version < "3.12"
+pillow==10.2.0 ; python_version >= "3.8" and python_version < "3.12"
 pkgutil-resolve-name==1.3.10 ; python_version >= "3.8" and python_version < "3.9"
-platformdirs==4.0.0 ; python_version >= "3.8" and python_version < "3.12"
+platformdirs==4.1.0 ; python_version >= "3.8" and python_version < "3.12"
 plotly==5.18.0 ; python_version >= "3.8" and python_version < "3.12"
 pluggy==1.3.0 ; python_version >= "3.8" and python_version < "3.12"
 pockets==0.9.1 ; python_version >= "3.8" and python_version < "3.12"
-prometheus-client==0.18.0 ; python_version >= "3.8" and python_version < "3.12"
-prompt-toolkit==3.0.41 ; python_version >= "3.8" and python_version < "3.12"
-psutil==5.9.6 ; python_version >= "3.8" and python_version < "3.12"
+prometheus-client==0.19.0 ; python_version >= "3.8" and python_version < "3.12"
+prompt-toolkit==3.0.43 ; python_version >= "3.8" and python_version < "3.12"
+psutil==5.9.8 ; 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")
 pure-eval==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
 pycparser==2.21 ; python_version >= "3.8" and python_version < "3.12"
-pygments==2.16.1 ; python_version >= "3.8" and python_version < "3.12"
+pygments==2.17.2 ; python_version >= "3.8" and python_version < "3.12"
 pylint-exit==1.2.0 ; python_version >= "3.8" and python_version < "3.12"
 pylint==2.17.7 ; python_version >= "3.8" and python_version < "3.12"
 pynmea2==1.19.0 ; python_version >= "3.8" and python_version < "3.12"
 pyparsing==3.1.1 ; python_version >= "3.8" and python_version < "3.12"
 pytest-cov==4.1.0 ; python_version >= "3.8" and python_version < "3.12"
 pytest-lazy-fixture==0.6.3 ; python_version >= "3.8" and python_version < "3.12"
-pytest==7.4.3 ; python_version >= "3.8" and python_version < "3.12"
+pytest==7.4.4 ; python_version >= "3.8" and python_version < "3.12"
 python-dateutil==2.8.2 ; python_version >= "3.8" and python_version < "3.12"
 python-json-logger==2.0.7 ; python_version >= "3.8" and python_version < "3.12"
 pytz==2023.3.post1 ; python_version >= "3.8" and python_version < "3.12"
 pywin32==306 ; sys_platform == "win32" and platform_python_implementation != "PyPy" and python_version >= "3.8" and python_version < "3.12"
 pywinpty==2.0.12 ; python_version >= "3.8" and python_version < "3.12" and os_name == "nt"
 pyyaml==6.0.1 ; python_version >= "3.8" and python_version < "3.12"
-pyzmq==25.1.1 ; python_version >= "3.8" and python_version < "3.12"
+pyzmq==25.1.2 ; python_version >= "3.8" and python_version < "3.12"
 qtconsole==5.5.1 ; python_version >= "3.8" and python_version < "3.12"
 qtpy==2.4.1 ; python_version >= "3.8" and python_version < "3.12"
-referencing==0.31.0 ; python_version >= "3.8" and python_version < "3.12"
+referencing==0.32.1 ; python_version >= "3.8" and python_version < "3.12"
 requests==2.31.0 ; python_version >= "3.8" and python_version < "3.12"
 rfc3339-validator==0.1.4 ; python_version >= "3.8" and python_version < "3.12"
 rfc3986-validator==0.1.1 ; python_version >= "3.8" and python_version < "3.12"
-rpds-py==0.13.0 ; python_version >= "3.8" and python_version < "3.12"
+rpds-py==0.17.1 ; python_version >= "3.8" and python_version < "3.12"
 scipy==1.10.1 ; python_version >= "3.8" and python_version < "3.12"
 send2trash==1.8.2 ; python_version >= "3.8" and python_version < "3.12"
-setuptools-scm==8.0.4 ; python_version >= "3.8" and python_version < "3.12"
-setuptools==68.2.2 ; python_version >= "3.8" and python_version < "3.12"
 six==1.16.0 ; python_version >= "3.8" and python_version < "3.12"
 sniffio==1.3.0 ; python_version >= "3.8" and python_version < "3.12"
 snowballstemmer==2.2.0 ; python_version >= "3.8" and python_version < "3.12"
@@ -145,19 +143,19 @@ terminado==0.18.0 ; 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_full_version <= "3.11.0a6"
 tomlkit==0.12.3 ; python_version >= "3.8" and python_version < "3.12"
-tornado==6.3.3 ; python_version >= "3.8" and python_version < "3.12"
+tornado==6.4 ; python_version >= "3.8" and python_version < "3.12"
 tqdm==4.66.1 ; python_version >= "3.8" and python_version < "3.12"
-traitlets==5.13.0 ; python_version >= "3.8" and python_version < "3.12"
-types-python-dateutil==2.8.19.14 ; python_version >= "3.8" and python_version < "3.12"
-typing-extensions==4.8.0 ; python_version >= "3.8" and python_version < "3.12"
-tzdata==2023.3 ; python_version >= "3.8" and python_version < "3.12"
+traitlets==5.14.1 ; python_version >= "3.8" and python_version < "3.12"
+types-python-dateutil==2.8.19.20240106 ; python_version >= "3.8" and python_version < "3.12"
+typing-extensions==4.9.0 ; python_version >= "3.8" and python_version < "3.11"
+tzdata==2023.4 ; python_version >= "3.8" and python_version < "3.12"
 unlzw3==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
 uri-template==1.3.0 ; python_version >= "3.8" and python_version < "3.12"
 urllib3==2.1.0 ; python_version >= "3.8" and python_version < "3.12"
-wcwidth==0.2.10 ; python_version >= "3.8" and python_version < "3.12"
+wcwidth==0.2.13 ; python_version >= "3.8" and python_version < "3.12"
 webcolors==1.13 ; python_version >= "3.8" and python_version < "3.12"
 webencodings==0.5.1 ; python_version >= "3.8" and python_version < "3.12"
-websocket-client==1.6.4 ; python_version >= "3.8" and python_version < "3.12"
+websocket-client==1.7.0 ; python_version >= "3.8" and python_version < "3.12"
 widgetsnbextension==4.0.9 ; python_version >= "3.8" and python_version < "3.12"
 wrapt==1.16.0 ; python_version >= "3.8" and python_version < "3.12"
 xarray==2023.1.0 ; python_version >= "3.8" and python_version < "3.12"
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,6 @@ parsers @@
        android
        clk
        google_decimeter
-       navdata
        nmea
        rinex_nav
        rinex_obs
@@ Expand Down @@