Skip to content

Commit 7c35e10

Browse files
kanhereashwinkanhereashwin
committed
Updated docs
1 parent c24823a commit 7c35e10

8 files changed

Lines changed: 79 additions & 59 deletions

File tree

‎docs/source/reference/parsers/modules.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ parsers
99
navdata
1010
nmea
1111
precise_ephemerides
12+
rinex
1213
smartloc

‎docs/source/reference/parsers/rinex.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
rinex module
2+
============
3+
4+
.. automodule:: rinex
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/reference/test_parsers/modules.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ parsers
99
test_navdata
1010
test_nmea
1111
test_precise_ephemerides
12+
test_rinex
1213
test_smartloc

‎docs/source/reference/test_parsers/test_rinex.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
test\_rinex module
2+
==================
3+
4+
.. automodule:: test_rinex
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/requirements.txt‎

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
alabaster==0.7.13 ; python_version >= "3.8" and python_version < "3.12"
2-
anyio==3.7.0 ; python_version >= "3.8" and python_version < "3.12"
2+
anyio==3.7.1 ; python_version >= "3.8" and python_version < "3.12"
33
appnope==0.1.3 ; python_version >= "3.8" and python_version < "3.12" and platform_system == "Darwin" or python_version >= "3.8" and python_version < "3.12" and sys_platform == "darwin"
44
argon2-cffi-bindings==21.2.0 ; python_version >= "3.8" and python_version < "3.12"
55
argon2-cffi==21.3.0 ; python_version >= "3.8" and python_version < "3.12"
66
arrow==1.2.3 ; python_version >= "3.8" and python_version < "3.12"
7-
astroid==2.15.5 ; python_version >= "3.8" and python_version < "3.12"
7+
astroid==2.15.6 ; python_version >= "3.8" and python_version < "3.12"
88
asttokens==2.2.1 ; python_version >= "3.8" and python_version < "3.12"
99
attrs==23.1.0 ; python_version >= "3.8" and python_version < "3.12"
1010
babel==2.12.1 ; python_version >= "3.8" and python_version < "3.12"
@@ -13,7 +13,7 @@ beautifulsoup4==4.12.2 ; python_version >= "3.8" and python_version < "3.12"
1313
bleach==6.0.0 ; python_version >= "3.8" and python_version < "3.12"
1414
certifi==2023.5.7 ; python_version >= "3.8" and python_version < "3.12"
1515
cffi==1.15.1 ; python_version >= "3.8" and python_version < "3.12"
16-
charset-normalizer==3.1.0 ; python_version >= "3.8" and python_version < "3.12"
16+
charset-normalizer==3.2.0 ; python_version >= "3.8" and python_version < "3.12"
1717
colorama==0.4.6 ; python_version >= "3.8" and python_version < "3.12" and sys_platform == "win32" or python_version >= "3.8" and python_version < "3.12" and platform_system == "Windows"
1818
comm==0.1.3 ; python_version >= "3.8" and python_version < "3.12"
1919
contourpy==1.1.0 ; python_version >= "3.8" and python_version < "3.12"
@@ -25,29 +25,30 @@ decorator==5.1.1 ; python_version >= "3.8" and python_version < "3.12"
2525
defusedxml==0.7.1 ; python_version >= "3.8" and python_version < "3.12"
2626
dill==0.3.6 ; python_version >= "3.8" and python_version < "3.12"
2727
docutils==0.16 ; python_version >= "3.8" and python_version < "3.12"
28-
exceptiongroup==1.1.1 ; python_version >= "3.8" and python_version < "3.11"
28+
exceptiongroup==1.1.2 ; python_version >= "3.8" and python_version < "3.11"
2929
executing==1.2.0 ; python_version >= "3.8" and python_version < "3.12"
3030
fastjsonschema==2.17.1 ; python_version >= "3.8" and python_version < "3.12"
31-
fonttools==4.40.0 ; python_version >= "3.8" and python_version < "3.12"
31+
fonttools==4.41.0 ; python_version >= "3.8" and python_version < "3.12"
3232
fqdn==1.5.1 ; python_version >= "3.8" and python_version < "3.12"
3333
georinex==1.16.1 ; python_version >= "3.8" and python_version < "3.12"
3434
hatanaka==2.8.1 ; python_version >= "3.8" and python_version < "3.12"
3535
idna==3.4 ; python_version >= "3.8" and python_version < "3.12"
3636
imagesize==1.4.1 ; python_version >= "3.8" and python_version < "3.12"
37-
importlib-metadata==6.7.0 ; python_version >= "3.8" and python_version < "3.10"
38-
importlib-resources==5.12.0 ; python_version >= "3.8" and python_version < "3.12"
37+
importlib-metadata==6.8.0 ; python_version >= "3.8" and python_version < "3.10"
38+
importlib-resources==6.0.0 ; python_version >= "3.8" and python_version < "3.12"
3939
iniconfig==2.0.0 ; python_version >= "3.8" and python_version < "3.12"
40-
ipykernel==6.23.3 ; python_version >= "3.8" and python_version < "3.12"
40+
ipykernel==6.24.0 ; python_version >= "3.8" and python_version < "3.12"
4141
ipython-genutils==0.2.0 ; python_version >= "3.8" and python_version < "3.12"
4242
ipython==8.12.2 ; python_version >= "3.8" and python_version < "3.12"
43-
ipywidgets==8.0.6 ; python_version >= "3.8" and python_version < "3.12"
43+
ipywidgets==8.0.7 ; python_version >= "3.8" and python_version < "3.12"
4444
isoduration==20.11.0 ; python_version >= "3.8" and python_version < "3.12"
4545
isort==5.12.0 ; python_version >= "3.8" and python_version < "3.12"
4646
jedi==0.18.2 ; python_version >= "3.8" and python_version < "3.12"
4747
jinja2==3.1.2 ; python_version >= "3.8" and python_version < "3.12"
4848
jsonpointer==2.4 ; python_version >= "3.8" and python_version < "3.12"
49-
jsonschema==4.17.3 ; python_version >= "3.8" and python_version < "3.12"
50-
jsonschema[format-nongpl]==4.17.3 ; python_version >= "3.8" and python_version < "3.12"
49+
jsonschema-specifications==2023.7.1 ; python_version >= "3.8" and python_version < "3.12"
50+
jsonschema==4.18.4 ; python_version >= "3.8" and python_version < "3.12"
51+
jsonschema[format-nongpl]==4.18.4 ; python_version >= "3.8" and python_version < "3.12"
5152
jupyter-client==8.3.0 ; python_version >= "3.8" and python_version < "3.12"
5253
jupyter-console==6.6.3 ; python_version >= "3.8" and python_version < "3.12"
5354
jupyter-core==5.3.1 ; python_version >= "3.8" and python_version < "3.12"
@@ -56,19 +57,19 @@ jupyter-server-terminals==0.4.4 ; python_version >= "3.8" and python_version < "
5657
jupyter-server==2.7.0 ; python_version >= "3.8" and python_version < "3.12"
5758
jupyter==1.0.0 ; python_version >= "3.8" and python_version < "3.12"
5859
jupyterlab-pygments==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
59-
jupyterlab-widgets==3.0.7 ; python_version >= "3.8" and python_version < "3.12"
60+
jupyterlab-widgets==3.0.8 ; python_version >= "3.8" and python_version < "3.12"
6061
kaleido==0.2.1 ; python_version >= "3.8" and python_version < "3.12"
6162
kiwisolver==1.4.4 ; python_version >= "3.8" and python_version < "3.12"
6263
lazy-object-proxy==1.9.0 ; python_version >= "3.8" and python_version < "3.12"
6364
markupsafe==2.1.3 ; python_version >= "3.8" and python_version < "3.12"
6465
matplotlib-inline==0.1.6 ; python_version >= "3.8" and python_version < "3.12"
65-
matplotlib==3.7.1 ; python_version >= "3.8" and python_version < "3.12"
66+
matplotlib==3.7.2 ; python_version >= "3.8" and python_version < "3.12"
6667
mccabe==0.7.0 ; python_version >= "3.8" and python_version < "3.12"
6768
mistune==3.0.1 ; python_version >= "3.8" and python_version < "3.12"
6869
nbclassic==1.0.0 ; python_version >= "3.8" and python_version < "3.12"
6970
nbclient==0.8.0 ; python_version >= "3.8" and python_version < "3.12"
70-
nbconvert==7.6.0 ; python_version >= "3.8" and python_version < "3.12"
71-
nbformat==5.9.0 ; python_version >= "3.8" and python_version < "3.12"
71+
nbconvert==7.7.2 ; python_version >= "3.8" and python_version < "3.12"
72+
nbformat==5.9.1 ; python_version >= "3.8" and python_version < "3.12"
7273
nbsphinx-link==1.3.0 ; python_version >= "3.8" and python_version < "3.12"
7374
nbsphinx==0.8.12 ; python_version >= "3.8" and python_version < "3.12"
7475
ncompress==1.0.1 ; python_version >= "3.8" and python_version < "3.12"
@@ -78,19 +79,19 @@ notebook==6.5.4 ; python_version >= "3.8" and python_version < "3.12"
7879
numpy==1.24.4 ; python_version < "3.12" and python_version >= "3.8"
7980
overrides==7.3.1 ; python_version >= "3.8" and python_version < "3.12"
8081
packaging==23.1 ; python_version >= "3.8" and python_version < "3.12"
81-
pandas==2.0.2 ; python_version >= "3.8" and python_version < "3.12"
82+
pandas==2.0.3 ; python_version >= "3.8" and python_version < "3.12"
8283
pandocfilters==1.5.0 ; python_version >= "3.8" and python_version < "3.12"
8384
parso==0.8.3 ; python_version >= "3.8" and python_version < "3.12"
8485
pexpect==4.8.0 ; python_version >= "3.8" and python_version < "3.12" and sys_platform != "win32"
8586
pickleshare==0.7.5 ; python_version >= "3.8" and python_version < "3.12"
86-
pillow==9.5.0 ; python_version >= "3.8" and python_version < "3.12"
87+
pillow==10.0.0 ; python_version >= "3.8" and python_version < "3.12"
8788
pkgutil-resolve-name==1.3.10 ; python_version >= "3.8" and python_version < "3.9"
88-
platformdirs==3.8.0 ; python_version >= "3.8" and python_version < "3.12"
89+
platformdirs==3.9.1 ; python_version >= "3.8" and python_version < "3.12"
8990
plotly==5.15.0 ; python_version >= "3.8" and python_version < "3.12"
9091
pluggy==1.2.0 ; python_version >= "3.8" and python_version < "3.12"
9192
pockets==0.9.1 ; python_version >= "3.8" and python_version < "3.12"
92-
prometheus-client==0.17.0 ; python_version >= "3.8" and python_version < "3.12"
93-
prompt-toolkit==3.0.38 ; python_version >= "3.8" and python_version < "3.12"
93+
prometheus-client==0.17.1 ; python_version >= "3.8" and python_version < "3.12"
94+
prompt-toolkit==3.0.39 ; python_version >= "3.8" and python_version < "3.12"
9495
psutil==5.9.5 ; python_version >= "3.8" and python_version < "3.12"
9596
ptyprocess==0.7.0 ; python_version >= "3.8" and python_version < "3.12" and os_name != "nt" or python_version >= "3.8" and python_version < "3.12" and sys_platform != "win32"
9697
pure-eval==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
@@ -99,24 +100,25 @@ pygments==2.15.1 ; python_version >= "3.8" and python_version < "3.12"
99100
pylint-exit==1.2.0 ; python_version >= "3.8" and python_version < "3.12"
100101
pylint==2.17.4 ; python_version >= "3.8" and python_version < "3.12"
101102
pynmea2==1.19.0 ; python_version >= "3.8" and python_version < "3.12"
102-
pyparsing==3.1.0 ; python_version >= "3.8" and python_version < "3.12"
103-
pyrsistent==0.19.3 ; python_version >= "3.8" and python_version < "3.12"
103+
pyparsing==3.0.9 ; python_version >= "3.8" and python_version < "3.12"
104104
pytest-cov==4.1.0 ; python_version >= "3.8" and python_version < "3.12"
105105
pytest-lazy-fixture==0.6.3 ; python_version >= "3.8" and python_version < "3.12"
106106
pytest==7.4.0 ; python_version >= "3.8" and python_version < "3.12"
107107
python-dateutil==2.8.2 ; python_version >= "3.8" and python_version < "3.12"
108108
python-json-logger==2.0.7 ; python_version >= "3.8" and python_version < "3.12"
109109
pytz==2023.3 ; python_version >= "3.8" and python_version < "3.12"
110110
pywin32==306 ; sys_platform == "win32" and platform_python_implementation != "PyPy" and python_version >= "3.8" and python_version < "3.12"
111-
pywinpty==2.0.10 ; python_version >= "3.8" and python_version < "3.12" and os_name == "nt"
112-
pyyaml==6.0 ; python_version >= "3.8" and python_version < "3.12"
111+
pywinpty==2.0.11 ; python_version >= "3.8" and python_version < "3.12" and os_name == "nt"
112+
pyyaml==6.0.1 ; python_version >= "3.8" and python_version < "3.12"
113113
pyzmq==25.1.0 ; python_version >= "3.8" and python_version < "3.12"
114114
qtconsole==5.4.3 ; python_version >= "3.8" and python_version < "3.12"
115115
qtpy==2.3.1 ; python_version >= "3.8" and python_version < "3.12"
116+
referencing==0.30.0 ; python_version >= "3.8" and python_version < "3.12"
116117
reindent==3.5.1 ; python_version >= "3.8" and python_version < "3.12"
117118
requests==2.31.0 ; python_version >= "3.8" and python_version < "3.12"
118119
rfc3339-validator==0.1.4 ; python_version >= "3.8" and python_version < "3.12"
119120
rfc3986-validator==0.1.1 ; python_version >= "3.8" and python_version < "3.12"
121+
rpds-py==0.9.2 ; python_version >= "3.8" and python_version < "3.12"
120122
scipy==1.10.1 ; python_version >= "3.8" and python_version < "3.12"
121123
send2trash==1.8.2 ; python_version >= "3.8" and python_version < "3.12"
122124
setuptools==68.0.0 ; python_version >= "3.8" and python_version < "3.12"
@@ -142,17 +144,17 @@ tomlkit==0.11.8 ; python_version >= "3.8" and python_version < "3.12"
142144
tornado==6.3.2 ; python_version >= "3.8" and python_version < "3.12"
143145
tqdm==4.65.0 ; python_version >= "3.8" and python_version < "3.12"
144146
traitlets==5.9.0 ; python_version >= "3.8" and python_version < "3.12"
145-
typing-extensions==4.6.3 ; python_version >= "3.8" and python_version < "3.11"
147+
typing-extensions==4.7.1 ; python_version >= "3.8" and python_version < "3.11"
146148
tzdata==2023.3 ; python_version >= "3.8" and python_version < "3.12"
147149
unlzw3==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
148150
uri-template==1.3.0 ; python_version >= "3.8" and python_version < "3.12"
149-
urllib3==2.0.3 ; python_version >= "3.8" and python_version < "3.12"
151+
urllib3==2.0.4 ; python_version >= "3.8" and python_version < "3.12"
150152
wcwidth==0.2.6 ; python_version >= "3.8" and python_version < "3.12"
151153
webcolors==1.13 ; python_version >= "3.8" and python_version < "3.12"
152154
webencodings==0.5.1 ; python_version >= "3.8" and python_version < "3.12"
153155
websocket-client==1.6.1 ; python_version >= "3.8" and python_version < "3.12"
154-
widgetsnbextension==4.0.7 ; python_version >= "3.8" and python_version < "3.12"
156+
widgetsnbextension==4.0.8 ; python_version >= "3.8" and python_version < "3.12"
155157
wrapt==1.15.0 ; python_version >= "3.8" and python_version < "3.12"
156158
xarray==2023.1.0 ; python_version >= "3.8" and python_version < "3.12"
157-
zipp==3.15.0 ; python_version >= "3.8" and python_version < "3.10"
159+
zipp==3.16.2 ; python_version >= "3.8" and python_version < "3.10"
158160
zope-interface==6.0 ; python_version >= "3.8" and python_version < "3.12"

‎gnss_lib_py/parsers/rinex.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ class RinexObs3(NavData):
3434
def __init__(self, input_path):
3535
"""Loading Rinex 3 observation files into a NavData based class.
3636
37-
Should input path to RXM-RAWX.csv file.
37+
Should input path to `.yyo` file.
3838
3939
Parameters
4040
----------
4141
input_path : string or path-like
42-
Path to measurement csv file
42+
Path to rinex .o file
4343
4444
"""
4545

‎notebooks/tutorials/parsers.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@
430430
"outputs": [],
431431
"source": [
432432
"# download Rinex obs file and load it into NavData instance\n",
433-
"!wget https://raw.githubusercontent.com/Stanford-NavLab/gnss_lib_py/main/data/unit_test/rinex/obs/rinex_obs_mixed_types.20o --quiet -O \"rinex_obs_mixed_types.20o\"\n",
433+
"!wget https://raw.githubusercontent.com/Stanford-NavLab/gnss_lib_py/ashwin/rinex-3-o/data/unit_test/rinex/obs/rinex_obs_mixed_types.20o --quiet -O \"rinex_obs_mixed_types.20o\"\n",
434434
"rinex_obs_3 = glp.RinexObs3(\"rinex_obs_mixed_types.20o\")\n",
435435
"print('Loaded Rinex Obs 3 data for the first time instant\\n', \\\n",
436436
" rinex_obs_3.where('gps_millis', rinex_obs_3['gps_millis', 0], 'eq'))"

0 commit comments

Comments
 (0)