Merge pull request #93 from Stanford-NavLab/derek/namespacing

Derek/namespacing

Author: kanhereashwin

docs/source/contributing/development.rst

@@ -41,6 +41,8 @@ Standard GitHub Workflow
      :code:`docs/source/index.rst` to match the :code:`README.md`
    * add a section in the appropriate tutorial notebook located in
      :code:`notebooks/tutorials/*`
+   * if the feature is in a new file, import the file in the
+     `module's import block <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/gnss_lib_py/__init__.py>`__.
 
 5. Add tests for the newly added code and ensure the new code is covered.
    See the :ref:`Testing<testing>` section for more details.
@@ -133,6 +135,8 @@ NAVLab GitHub Workflow
      :code:`docs/source/index.rst` to match the :code:`README.md`
    * add a section in the appropriate tutorial notebook located in
      :code:`notebooks/tutorials/*`
+   * if the feature is in a new file, import the file in the
+     `module's import block <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/gnss_lib_py/__init__.py>`__.
 
 5. Add tests for the newly added code and ensure the new code is covered.
    See the :ref:`Testing<testing>` section for more details.
@@ -242,6 +246,8 @@ Pull Request Review Workflow
    * the appropriate tutorial notebook located in
      :code:`notebooks/tutorials/*` with a simple example of the new
      functionality
+   * if a new file was created, it should likely be imported in the
+     `module's import block <https://github.com/Stanford-NavLab/gnss_lib_py/blob/main/gnss_lib_py/__init__.py>`__.
 
 4. Verify that all tests run on your system:
 

gnss_lib_py/__init__.py

@@ -0,0 +1,22 @@
+"""Handle version and add submodules to gnss_lib_py namesppace."""
+
+from importlib import metadata
+
+# import submodules into gnss_lib_py namespace
+from gnss_lib_py.algorithms.gnss_filters import *
+from gnss_lib_py.algorithms.residuals import *
+from gnss_lib_py.algorithms.snapshot import *
+
+from gnss_lib_py.parsers.android import *
+from gnss_lib_py.parsers.ephemeris import *
+from gnss_lib_py.parsers.navdata import *
+from gnss_lib_py.parsers.precise_ephemerides import *
+
+from gnss_lib_py.utils.coordinates import *
+from gnss_lib_py.utils.filters import *
+from gnss_lib_py.utils.sim_gnss import *
+from gnss_lib_py.utils.time_conversions import *
+from gnss_lib_py.utils.visualizations import *
+
+# single location of version exists in pyproject.toml
+__version__ = metadata.version("gnss-lib-py")

notebooks/timing_comparisons.ipynb

@@ -42,7 +42,7 @@
    "outputs": [],
    "source": [
     "SETUP_CODE = '''\n",
-    "from gnss_lib_py.parsers.android import AndroidDerived2021\n",
+    "from gnss_lib_py import AndroidDerived2021\n",
     "\n",
     "# load Android Google Challenge data\n",
     "navdata = AndroidDerived2021(\"Pixel4XL_derived.csv\", remove_timing_outliers=False)\n",
@@ -74,7 +74,7 @@
     "SETUP_CODE = '''\n",
     "import pandas as pd\n",
     "\n",
-    "from gnss_lib_py.parsers.android import AndroidDerived2021\n",
+    "from gnss_lib_py import AndroidDerived2021\n",
     "\n",
     "# load Android Google Challenge data\n",
     "df = pd.read_csv(\"Pixel4XL_derived.csv\")\n",
@@ -107,7 +107,7 @@
     "SETUP_CODE = '''\n",
     "import pandas as pd\n",
     "\n",
-    "from gnss_lib_py.parsers.android import AndroidDerived2021\n",
+    "from gnss_lib_py import AndroidDerived2021\n",
     "\n",
     "# load Android Google Challenge data\n",
     "df = pd.read_csv(\"Pixel4XL_derived.csv\")\n",

notebooks/tutorials/algorithms.ipynb

@@ -15,9 +15,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.android import AndroidDerived2021\n",
-    "from gnss_lib_py.algorithms.snapshot import solve_wls\n",
-    "from gnss_lib_py.utils.visualizations import plot_map"
+    "import gnss_lib_py as glp"
    ]
   },
   {
@@ -29,7 +27,7 @@
    "source": [
     "# load Android Google Challenge data\n",
     "!wget https://raw.githubusercontent.com/Stanford-NavLab/gnss_lib_py/main/data/unit_test/android_2021/Pixel4XL_derived.csv --quiet -O \"Pixel4XL_derived.csv\"\n",
-    "derived_data = AndroidDerived2021(\"Pixel4XL_derived.csv\", remove_timing_outliers=False)"
+    "derived_data = glp.AndroidDerived2021(\"Pixel4XL_derived.csv\", remove_timing_outliers=False)"
    ]
   },
   {
@@ -47,7 +45,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "state_wls = solve_wls(derived_data)"
+    "state_wls = glp.solve_wls(derived_data)"
    ]
   },
   {
@@ -65,7 +63,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plot_map(state_wls)"
+    "glp.plot_map(state_wls)"
    ]
   },
   {
@@ -83,9 +81,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.android import AndroidDerived2021\n",
-    "from gnss_lib_py.algorithms.gnss_filters import solve_gnss_ekf\n",
-    "from gnss_lib_py.utils.visualizations import plot_map"
+    "import gnss_lib_py as glp"
    ]
   },
   {
@@ -97,7 +93,7 @@
    "source": [
     "# load Android Google Challenge data\n",
     "!wget https://raw.githubusercontent.com/Stanford-NavLab/gnss_lib_py/main/data/unit_test/android_2021/Pixel4XL_derived.csv --quiet -O \"Pixel4XL_derived.csv\"\n",
-    "derived_data = AndroidDerived2021(\"Pixel4XL_derived.csv\", remove_timing_outliers=False)"
+    "derived_data = glp.AndroidDerived2021(\"Pixel4XL_derived.csv\", remove_timing_outliers=False)"
    ]
   },
   {
@@ -117,7 +113,7 @@
    },
    "outputs": [],
    "source": [
-    "state_ekf = solve_gnss_ekf(derived_data)"
+    "state_ekf = glp.solve_gnss_ekf(derived_data)"
    ]
   },
   {
@@ -135,7 +131,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plot_map(state_ekf)"
+    "glp.plot_map(state_ekf)"
    ]
   },
   {
@@ -153,8 +149,28 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.algorithms.residuals import solve_residuals\n",
-    "from gnss_lib_py.utils.visualizations import plot_metric_by_constellation\n",
+    "import gnss_lib_py as glp"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "12285e7e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# load Android Google Challenge data\n",
+    "!wget https://raw.githubusercontent.com/Stanford-NavLab/gnss_lib_py/main/data/unit_test/android_2021/Pixel4XL_derived.csv --quiet -O \"Pixel4XL_derived.csv\"\n",
+    "derived_data = glp.AndroidDerived2021(\"Pixel4XL_derived.csv\", remove_timing_outliers=False)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e92db703",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "galileo_data = derived_data.where(\"gnss_id\",\"galileo\")"
    ]
   },
@@ -173,7 +189,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "solve_residuals(galileo_data, state_wls, inplace=True)"
+    "glp.solve_residuals(galileo_data, state_wls, inplace=True)"
    ]
   },
   {
@@ -191,7 +207,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "figs = plot_metric_by_constellation(galileo_data, \"gps_millis\", \"residuals_m\")"
+    "figs = glp.plot_metric_by_constellation(galileo_data, \"gps_millis\", \"residuals_m\")"
    ]
   }
  ],

notebooks/tutorials/coordinates.ipynb

@@ -14,7 +14,7 @@
    "outputs": [],
    "source": [
     "import numpy as np\n",
-    "from gnss_lib_py.utils import coordinates as coord"
+    "import gnss_lib_py as glp"
    ]
   },
   {
@@ -34,11 +34,11 @@
     "# Using the LLA coordinates the Aero/Astro department at Stanford University\n",
     "x_lla = np.array([[37.427112], [-122.1764146], [16]])\n",
     "print('Converted ECEF coordinates')\n",
-    "print(coord.geodetic_to_ecef(x_lla))\n",
+    "print(glp.geodetic_to_ecef(x_lla))\n",
     "\n",
     "x_ecef = np.array([[-2700628], [-4292443], [3855152]])\n",
     "print('Converted LLA coordinates')\n",
-    "print(coord.ecef_to_geodetic(x_ecef))"
+    "print(glp.ecef_to_geodetic(x_ecef))"
    ]
   },
   {
@@ -64,11 +64,11 @@
    "outputs": [],
    "source": [
     "# Instantiate using LLA coordinates\n",
-    "local_frame = coord.LocalCoord.from_geodetic(x_lla)\n",
+    "local_frame = glp.LocalCoord.from_geodetic(x_lla)\n",
     "print('NED to ECEF conversion matrix for initialized local frame')\n",
     "print(local_frame.ned_to_ecef_matrix)\n",
     "\n",
-    "local_frame = coord.LocalCoord.from_geodetic(x_ecef)\n",
+    "local_frame = glp.LocalCoord.from_geodetic(x_ecef)\n",
     "print('NED to ECEF conversion matrix for initialized local frame')\n",
     "print(local_frame.ned_to_ecef_matrix)"
    ]
@@ -143,8 +143,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.utils.coordinates import ecef_to_el_az\n",
-    "from gnss_lib_py.parsers.android import AndroidDerived2022\n",
+    "from gnss_lib_py import ecef_to_el_az\n",
+    "from gnss_lib_py import AndroidDerived2022\n",
     "\n",
     "# load Android Google Challenge data\n",
     "!wget https://raw.githubusercontent.com/Stanford-NavLab/gnss_lib_py/main/data/unit_test/android_2022/device_gnss.csv --quiet -O \"device_gnss.csv\"\n",

notebooks/tutorials/navdata.ipynb

@@ -9,7 +9,7 @@
     "import numpy as np\n",
     "import pandas as pd\n",
     "\n",
-    "from gnss_lib_py.parsers.navdata import NavData"
+    "from gnss_lib_py import NavData"
    ]
   },
   {

notebooks/tutorials/parsers.ipynb

@@ -31,7 +31,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.android import AndroidDerived2022"
+    "from gnss_lib_py import AndroidDerived2022"
    ]
   },
   {
@@ -99,7 +99,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.android import AndroidGroundTruth2022"
+    "from gnss_lib_py import AndroidGroundTruth2022"
    ]
   },
   {
@@ -161,7 +161,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.android import solve_kaggle_baseline\n",
+    "from gnss_lib_py import solve_kaggle_baseline\n",
     "\n",
     "state_estimate = solve_kaggle_baseline(derived_data)\n",
     "\n",
@@ -183,7 +183,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.android import prepare_kaggle_submission\n",
+    "from gnss_lib_py import prepare_kaggle_submission\n",
     "\n",
     "solution = prepare_kaggle_submission(state_estimate, trip_id = \"my_trace/my_phone\")\n",
     "\n",
@@ -205,8 +205,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.android import solve_kaggle_dataset\n",
-    "from gnss_lib_py.algorithms.snapshot import solve_wls\n",
+    "from gnss_lib_py import solve_kaggle_dataset\n",
+    "from gnss_lib_py import solve_wls\n",
     "\n",
     "# submission = solve_kaggle_dataset(folder_path = \"/path/to/train/or/test/folder/\", \n",
     "#                                   solver = solve_wls)\n",
@@ -238,7 +238,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.android import AndroidDerived2021"
+    "from gnss_lib_py import AndroidDerived2021"
    ]
   },
   {
@@ -306,7 +306,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.android import AndroidGroundTruth2021"
+    "from gnss_lib_py import AndroidGroundTruth2021"
    ]
   },
   {
@@ -383,8 +383,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.precise_ephemerides import multi_gnss_from_precise_eph\n",
-    "from gnss_lib_py.parsers.android import AndroidDerived2021\n",
+    "from gnss_lib_py import multi_gnss_from_precise_eph\n",
+    "from gnss_lib_py import AndroidDerived2021\n",
     "import numpy as np\n",
     "\n",
     "# load Android Google Challenge data\n",
@@ -656,7 +656,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.parsers.navdata import NavData\n",
+    "from gnss_lib_py import NavData\n",
     "\n",
     "class MyReceiver(NavData):\n",
     "    \"\"\"Class handling measurements from MyReceiver.\n",
@@ -758,7 +758,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from gnss_lib_py.utils.visualizations import plot_metric\n",
+    "from gnss_lib_py import plot_metric\n",
     "fig = plot_metric(my_receiver_data,\"gps_millis\",\"corr_pr_m\",groupby=\"sv_id\")"
    ]
   }