Merge pull request #69 from Stanford-NavLab/derwin/pypi

Derwin/pypi

Author: kanhereashwin

CITATION.bib

@@ -0,0 +1,8 @@
+@inproceedings{knowlesmodular2022,
+   title = {A Modular and Extendable GNSS Python Library},
+   author={Knowles, Derek and Kanhere, Ashwin V and Bhamidipati, Sriramya and Gao, Grace},
+   booktitle={Proceedings of the 35th International Technical Meeting of the Satellite Division of The Institute of Navigation (ION GNSS+ 2022)},
+   institution = {Stanford University},
+   year = {2022 [Online]},
+   url = {https://github.com/Stanford-NavLab/gnss_lib_py},
+}

README.md

@@ -6,14 +6,15 @@ gnss_lib_py
 ===========
 
 `gnss_lib_py` is a modular Python tool for parsing, analyzing, and
-visualizing Global Navigation Satellite Systems (GNSS) data.
+visualizing Global Navigation Satellite Systems (GNSS) data and state
+estimates.
 It also provides an intuitive and modular framework allowing users to
 quickly prototype, implement, and visualize GNSS algorithms.
 `gnss_lib_py` is modular in the sense that multiple types of
 algorithms can be easily exchanged for each other and extendable in
 facilitating user-specific extensions of existing implementations.
 
-<img src="docs/source/img/skyplot.png" alt="satellite skyplot" width="600"/>
+<img src="https://raw.githubusercontent.com/Stanford-NavLab/gnss_lib_py/main/docs/source/img/skyplot.png" alt="satellite skyplot" width="600"/>
 
 `gnss_lib_py` contains parsers for common file types used for
 storing GNSS measurements, benchmark algorithms for processing

docs/source/index.rst

@@ -9,7 +9,8 @@ gnss_lib_py
 .. _mainpage:
 
 :code:`gnss_lib_py` is a modular Python tool for parsing, analyzing, and
-visualizing Global Navigation Satellite Systems (GNSS) data.
+visualizing Global Navigation Satellite Systems (GNSS) data and state
+estimates.
 It also provides an intuitive and modular framework allowing users to
 quickly prototype, implement, and visualize GNSS algorithms.
 :code:`gnss_lib_py` is modular in the sense that multiple types of

gnss_lib_py/__init__.py

@@ -1 +0,0 @@
-__version__ = '0.1.0'

pyproject.toml

@@ -1,9 +1,20 @@
 [tool.poetry]
 name = "gnss-lib-py"
-version = "0.1.0"
-description = "Python code to process, simulate and demonstrate using GNSS measurements"
-authors = ["Ashwin Kanhere"]
+version = "0.1.6"
+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>",
+           ]
 license = "MIT"
+readme = "README.md"
+homepage = "https://github.com/Stanford-NavLab/gnss_lib_py"
+documentation = "https://gnss-lib-py.readthedocs.io/en/latest/"
+keywords = ["gnss"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
 
 [tool.poetry.dependencies]
 python = ">=3.8, < 3.11"