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

V1.0.0

Author: betaBison

.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

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

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
 -----------------

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

docs/source/reference/parsers/modules.rst

@@ -7,7 +7,6 @@ parsers
    android
    clk
    google_decimeter
-   navdata
    nmea
    rinex_nav
    rinex_obs

docs/source/reference/parsers/navdata.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
 ---------------------------

docs/source/reference/reference.rst

@@ -7,7 +7,6 @@ parsers
    test_android
    test_clk
    test_google_decimeter
-   test_navdata
    test_nmea
    test_rinex_nav
    test_rinex_obs

docs/source/reference/test_parsers/modules.rst

@@ -12,4 +12,3 @@ utils
    test_gnss_models
    test_sv_models
    test_time_conversions
-   test_visualizations