Merge pull request #87 from Stanford-NavLab/derek/release-0.1.8

Derek/release 0.1.8

Author: kanhereashwin

.github/workflows/build.yml

@@ -36,7 +36,6 @@ jobs:
         virtualenvs-create: true
         virtualenvs-in-project: true
         installer-parallel: true # default option selected currently
-        version: 1.1.14
     # Load cached environment, if it exists
     - name: Load cached poetry environment
       id: cached-poetry-dependencies

build_docs.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 # export requirements.txt for buildings docs
-poetry export -f requirements.txt --output ./docs/source/requirements.txt --dev --without-hashes
+poetry export -f requirements.txt --output ./docs/source/requirements.txt --with dev --without-hashes
 cd docs
 
 echo "Rebuilding References"

docs/source/conf.py

@@ -42,6 +42,7 @@
                 'sphinx.ext.napoleon',
                 'nbsphinx',
                 'nbsphinx_link',
+                'IPython.sphinxext.ipython_console_highlighting',
 ]
 
 # Specify which files are source files for Sphinx

docs/source/contributing/development.rst

@@ -174,7 +174,7 @@ Pull Request Review Workflow
 
    If the feature branch included new functionality, the following
    should have also been updated:
-   
+
    * the "Code Organization" section of the :code:`README.md`
    * the "Code Organization" section of
      :code:`docs/source/index.rst` to match the :code:`README.md`
@@ -204,3 +204,29 @@ Pull Request Review Workflow
    See the :ref:`Coverage Report<coverage>` section for more details.
 
 7. Submit your approval or any comments on GitHub.
+
+New Package Release Workflow
+----------------------------
+
+1. Create new branch for the release:
+
+   .. code-block:: bash
+
+      git checkout -b your-name/release-X.Y.Z
+
+2. Open the ``pyproject.toml`` file and under the ``[tool.poetry]``
+   group change the ``version = X.Y.Z`` variable to match the new
+   package version number.
+
+3. Create a new pull request and merge to the ``main`` branch using the
+   development process above.
+
+4. Go to the `releases page <https://github.com/Stanford-NavLab/gnss_lib_py/releases>`__
+   on GitHub and click the ``Draft a new release`` button on the top.
+   Click ``Choose a tag`` and add a new tag named ``X.Y.Z`` matching the
+   new package version number. Target the ``main`` branch. Finally,
+   click the ``Publish release`` button.
+
+5. Allow time for the release to build and then check
+   `pypi <https://pypi.org/project/gnss-lib-py/>`__
+   to ensure that the release was built successfully.

docs/source/contributing/documentation.rst

@@ -162,7 +162,7 @@ If you wish to add python dependencies:
 
     * add the new dependency to the poetry dependency list with
       :code:`poetry add package=version` or if the dependency is a
-      development tool :code:`poetry add --dev package=version`
+      development tool :code:`poetry add package=version --group dev`
 
 If you wish to remove python dependencies, use :code:`poetry remove package`.
 

docs/source/install.rst

@@ -107,7 +107,7 @@ Linux/WSL2 and MacOS
    if different than 3.8.9) to set the Python version that code in the
    repository will run.
 
-5. Install :code:`poetry` using the instructions
+5. Install :code:`poetry>=1.2` using the instructions
    `here <https://python-poetry.org/docs/master/#installation>`__.
 
 6. Install Python dependencies using :code:`poetry install`.

docs/source/reference/reference.rst

@@ -3,6 +3,29 @@
 Reference
 =========
 
+General GNSS References
+-----------------------
+
+The GNSS in ``gnss_lib_py`` stands for Global Navigation Satellite
+System(s). The following is a list of references that might be helpful
+in learning more about GNSS:
+
+* *Global Positioning System: Signals, Measurements, and Performance* by
+  Pratap Misra and Per Enge.
+* *Positioning, Navigation, and Timing Technologies in the 21st Century*
+  edited by Y. Jade Morton, Frank van Diggelen, James J. Spilker Jr,
+  Bradford W. Parkinson, Sherman Lo, and Grace Gao.
+* *Understanding GPS/GNSS: Principles and Applications* edited by
+  Elliott D. Kaplan and Christopher J. Hegarty.
+* "GPS: An Introduction to Satellite Navigation" by Frank van Diggelen
+  found on `YouTube <https://www.youtube.com/playlist?list=PLGvhNIiu1ubyEOJga50LJMzVXtbUq6CPo>`__:
+  a playlist of online classes that teach a broad overview of GNSS
+  topics.
+*  "GPS" by Bartosz Ciechanowski found at
+   `ciechanow.ski/gps <https://ciechanow.ski/gps/>`__:
+   a visually-appealing and interactive blog post about some of the
+   basic principles of GNSS positioning.
+
 Package Architecture
 --------------------
 

docs/source/requirements.txt

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gnss-lib-py"
-version = "0.1.7"
+version = "0.1.8"
 description = "Modular Python tool for parsing, analyzing, and visualizing Global Navigation Satellite Systems (GNSS) data and state estimates"
 authors = ["Derek Knowles <dcknowles@stanford.edu>",
            "Ashwin Kanhere <akanhere@stanford.edu>",
@@ -35,7 +35,7 @@ matplotlib = "^3.5.1"
 plotly = "^5.8.0"
 kaleido = "0.2.1"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 Sphinx = "^4.1.1"
 sphinx-rtd-theme = "^0.5.2"
 sphinxcontrib-napoleon = "^0.7"