Skip to content

Commit d9d3bad

Browse files
betaBisonbetaBison
committed
docs building
1 parent 42b2e20 commit d9d3bad

8 files changed

Lines changed: 66 additions & 76 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,11 @@ In the directory organization above:
8080

8181
* [2021 Google Android Derived Dataset](https://www.kaggle.com/c/google-smartphone-decimeter-challenge)
8282
* [2022 Google Android Derived Dataset](https://www.kaggle.com/competitions/smartphone-decimeter-2022)
83-
* [Precise Ephemeris Data](https://cddis.nasa.gov/Data_and_Derived_Products/GNSS/gnss_mgex.html)
8483
* [TU Chemnitz smartLoc Dataset](https://www.tu-chemnitz.de/projekt/smartLoc/gnss_dataset.html.en#Datasets)
8584
* [NMEA](https://www.sparkfun.com/datasheets/GPS/NMEA%20Reference%20Manual-Rev2.1-Dec07.pdf)
8685
* [RINEX .o and .n] (https://files.igs.org/pub/data/format/rinex305.pdf)
86+
* [SP3 precise orbits](https://cddis.nasa.gov/Data_and_Derived_Products/GNSS/orbit_products.html)
87+
* [CLK clock products](https://cddis.nasa.gov/Data_and_Derived_Products/GNSS/clock_products.html)
8788

8889
* The `utils` directory contains utilities used to handle
8990
GNSS measurements, time conversions, visualizations, satellite

‎build_docs.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
#!/bin/bash
22
# export requirements.txt for buildings docs
33
poetry export -f requirements.txt --output ./docs/source/requirements.txt --with dev --without-hashes
4+
# export requirements.txt for Conda environment setup
5+
poetry export -f requirements.txt --output ./requirements.txt --without-hashes
46
cd docs
57

68
echo "Rebuilding References"
@@ -26,6 +28,4 @@ poetry run make clean
2628
echo "Building docs in html"
2729
poetry run make html
2830

29-
# export requirements.txt for Conda environment setup
3031
cd ..
31-
poetry export -f requirements.txt --output ./requirements.txt --without-hashes

‎docs/source/index.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,11 @@ In the directory organization above:
8989

9090
* `2021 Google Android Derived Dataset <https://www.kaggle.com/c/google-smartphone-decimeter-challenge>`__
9191
* `2022 Google Android Derived Dataset <https://www.kaggle.com/competitions/smartphone-decimeter-2022>`__
92-
* `Precise Ephemeris Data <https://cddis.nasa.gov/Data_and_Derived_Products/GNSS/gnss_mgex.html>`__
9392
* `TU Chemnitz smartLoc Dataset <https://www.tu-chemnitz.de/projekt/smartLoc/gnss_dataset.html.en#Datasets>`__
9493
* `NMEA <https://www.sparkfun.com/datasheets/GPS/NMEA%20Reference%20Manual-Rev2.1-Dec07.pdf>`__
9594
* `RINEX .n and .o <https://files.igs.org/pub/data/format/rinex305.pdf>`__
95+
* `SP3 precise orbits <https://cddis.nasa.gov/Data_and_Derived_Products/GNSS/orbit_products.html>`__
96+
* `CLK clock products <https://cddis.nasa.gov/Data_and_Derived_Products/GNSS/clock_products.html>`__
9697

9798
* The :code:`utils` directory contains utilities used to handle
9899
GNSS measurements, time conversions, visualizations, satellite

‎docs/source/reference/reference.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ Timing Conventions
117117
------------------
118118

119119
We use four different time formats in :code:`gnss_lib_py`:
120+
120121
* :code:`gps_millis` : The number of milliseconds that have elapsed since
121122
the start of the GPS epoch on January 6th, 1980. This time format is
122123
continuous and is not adjusted with leap seconds. This time is stored
@@ -139,7 +140,7 @@ between all these time formats are provided in the
139140

140141
Between these four time formats, all major applications of GNSS-based
141142
state estimation should be covered and any of these time formats can be
142-
used interchangably.
143+
used interchangeably.
143144

144145

145146
Standard Naming Conventions

‎docs/source/requirements.txt‎

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
alabaster==0.7.13 ; python_version >= "3.8" and python_version < "3.12"
22
anyio==3.7.1 ; python_version >= "3.8" and python_version < "3.12"
3-
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"
3+
appnope==0.1.3 ; python_version >= "3.8" and python_version < "3.12" and (platform_system == "Darwin" or 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"
@@ -11,24 +11,25 @@ babel==2.12.1 ; python_version >= "3.8" and python_version < "3.12"
1111
backcall==0.2.0 ; python_version >= "3.8" and python_version < "3.12"
1212
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"
14-
certifi==2023.5.7 ; python_version >= "3.8" and python_version < "3.12"
14+
certifi==2023.7.22 ; python_version >= "3.8" and python_version < "3.12"
1515
cffi==1.15.1 ; python_version >= "3.8" and python_version < "3.12"
1616
charset-normalizer==3.2.0 ; python_version >= "3.8" and python_version < "3.12"
17-
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"
18-
comm==0.1.3 ; python_version >= "3.8" and python_version < "3.12"
17+
colorama==0.4.6 ; python_version >= "3.8" and python_version < "3.12" and (sys_platform == "win32" or platform_system == "Windows")
18+
comm==0.1.4 ; python_version >= "3.8" and python_version < "3.12"
1919
contourpy==1.1.0 ; python_version >= "3.8" and python_version < "3.12"
2020
coverage[toml]==7.2.7 ; python_version >= "3.8" and python_version < "3.12"
2121
cycler==0.11.0 ; python_version >= "3.8" and python_version < "3.12"
2222
datetime==4.9 ; python_version >= "3.8" and python_version < "3.12"
2323
debugpy==1.6.7 ; python_version >= "3.8" and python_version < "3.12"
2424
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"
26-
dill==0.3.6 ; python_version >= "3.8" and python_version < "3.12"
26+
dill==0.3.7 ; python_version >= "3.8" and python_version < "3.12"
2727
docutils==0.16 ; python_version >= "3.8" and python_version < "3.12"
28+
entrypoints==0.4 ; python_version >= "3.8" and python_version < "3.12"
2829
exceptiongroup==1.1.2 ; python_version >= "3.8" and python_version < "3.11"
2930
executing==1.2.0 ; python_version >= "3.8" and python_version < "3.12"
30-
fastjsonschema==2.17.1 ; python_version >= "3.8" and python_version < "3.12"
31-
fonttools==4.41.0 ; python_version >= "3.8" and python_version < "3.12"
31+
fastjsonschema==2.18.0 ; python_version >= "3.8" and python_version < "3.12"
32+
fonttools==4.42.0 ; python_version >= "3.8" and python_version < "3.12"
3233
fqdn==1.5.1 ; python_version >= "3.8" and python_version < "3.12"
3334
georinex==1.16.1 ; python_version >= "3.8" and python_version < "3.12"
3435
hatanaka==2.8.1 ; python_version >= "3.8" and python_version < "3.12"
@@ -37,22 +38,22 @@ imagesize==1.4.1 ; python_version >= "3.8" and python_version < "3.12"
3738
importlib-metadata==6.8.0 ; python_version >= "3.8" and python_version < "3.10"
3839
importlib-resources==6.0.0 ; python_version >= "3.8" and python_version < "3.12"
3940
iniconfig==2.0.0 ; python_version >= "3.8" and python_version < "3.12"
40-
ipykernel==6.24.0 ; python_version >= "3.8" and python_version < "3.12"
41+
ipykernel==6.25.0 ; python_version >= "3.8" and python_version < "3.12"
4142
ipython-genutils==0.2.0 ; python_version >= "3.8" and python_version < "3.12"
4243
ipython==8.12.2 ; python_version >= "3.8" and python_version < "3.12"
43-
ipywidgets==8.0.7 ; python_version >= "3.8" and python_version < "3.12"
44+
ipywidgets==8.1.0 ; python_version >= "3.8" and python_version < "3.12"
4445
isoduration==20.11.0 ; python_version >= "3.8" and python_version < "3.12"
4546
isort==5.12.0 ; python_version >= "3.8" and python_version < "3.12"
46-
jedi==0.18.2 ; python_version >= "3.8" and python_version < "3.12"
47+
jedi==0.19.0 ; python_version >= "3.8" and python_version < "3.12"
4748
jinja2==3.1.2 ; python_version >= "3.8" and python_version < "3.12"
4849
jsonpointer==2.4 ; python_version >= "3.8" and python_version < "3.12"
4950
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"
52-
jupyter-client==8.3.0 ; python_version >= "3.8" and python_version < "3.12"
51+
jsonschema==4.18.6 ; python_version >= "3.8" and python_version < "3.12"
52+
jsonschema[format-nongpl]==4.18.6 ; python_version >= "3.8" and python_version < "3.12"
53+
jupyter-client==7.4.9 ; python_version >= "3.8" and python_version < "3.12"
5354
jupyter-console==6.6.3 ; python_version >= "3.8" and python_version < "3.12"
5455
jupyter-core==5.3.1 ; python_version >= "3.8" and python_version < "3.12"
55-
jupyter-events==0.6.3 ; python_version >= "3.8" and python_version < "3.12"
56+
jupyter-events==0.7.0 ; python_version >= "3.8" and python_version < "3.12"
5657
jupyter-server-terminals==0.4.4 ; python_version >= "3.8" and python_version < "3.12"
5758
jupyter-server==2.7.0 ; python_version >= "3.8" and python_version < "3.12"
5859
jupyter==1.0.0 ; python_version >= "3.8" and python_version < "3.12"
@@ -68,15 +69,15 @@ mccabe==0.7.0 ; python_version >= "3.8" and python_version < "3.12"
6869
mistune==3.0.1 ; python_version >= "3.8" and python_version < "3.12"
6970
nbclassic==1.0.0 ; python_version >= "3.8" and python_version < "3.12"
7071
nbclient==0.8.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"
72+
nbconvert==7.7.3 ; python_version >= "3.8" and python_version < "3.12"
73+
nbformat==5.9.2 ; python_version >= "3.8" and python_version < "3.12"
7374
nbsphinx-link==1.3.0 ; python_version >= "3.8" and python_version < "3.12"
7475
nbsphinx==0.8.12 ; python_version >= "3.8" and python_version < "3.12"
7576
ncompress==1.0.1 ; python_version >= "3.8" and python_version < "3.12"
76-
nest-asyncio==1.5.6 ; python_version >= "3.8" and python_version < "3.12"
77+
nest-asyncio==1.5.7 ; python_version >= "3.8" and python_version < "3.12"
7778
notebook-shim==0.2.3 ; python_version >= "3.8" and python_version < "3.12"
78-
notebook==6.5.4 ; python_version >= "3.8" and python_version < "3.12"
79-
numpy==1.24.4 ; python_version < "3.12" and python_version >= "3.8"
79+
notebook==6.5.5 ; python_version >= "3.8" and python_version < "3.12"
80+
numpy==1.24.4 ; python_version >= "3.8" and python_version < "3.12"
8081
overrides==7.3.1 ; python_version >= "3.8" and python_version < "3.12"
8182
packaging==23.1 ; python_version >= "3.8" and python_version < "3.12"
8283
pandas==2.0.3 ; python_version >= "3.8" and python_version < "3.12"
@@ -86,19 +87,20 @@ pexpect==4.8.0 ; python_version >= "3.8" and python_version < "3.12" and sys_pla
8687
pickleshare==0.7.5 ; python_version >= "3.8" and python_version < "3.12"
8788
pillow==10.0.0 ; python_version >= "3.8" and python_version < "3.12"
8889
pkgutil-resolve-name==1.3.10 ; python_version >= "3.8" and python_version < "3.9"
89-
platformdirs==3.9.1 ; python_version >= "3.8" and python_version < "3.12"
90+
platformdirs==3.10.0 ; python_version >= "3.8" and python_version < "3.12"
9091
plotly==5.15.0 ; python_version >= "3.8" and python_version < "3.12"
9192
pluggy==1.2.0 ; python_version >= "3.8" and python_version < "3.12"
9293
pockets==0.9.1 ; python_version >= "3.8" and python_version < "3.12"
9394
prometheus-client==0.17.1 ; python_version >= "3.8" and python_version < "3.12"
9495
prompt-toolkit==3.0.39 ; python_version >= "3.8" and python_version < "3.12"
9596
psutil==5.9.5 ; python_version >= "3.8" and python_version < "3.12"
96-
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"
97+
ptyprocess==0.7.0 ; python_version >= "3.8" and python_version < "3.12" and (os_name != "nt" or sys_platform != "win32")
9798
pure-eval==0.2.2 ; python_version >= "3.8" and python_version < "3.12"
99+
py==1.11.0 ; python_version >= "3.8" and python_version < "3.12" and implementation_name == "pypy"
98100
pycparser==2.21 ; python_version >= "3.8" and python_version < "3.12"
99101
pygments==2.15.1 ; python_version >= "3.8" and python_version < "3.12"
100102
pylint-exit==1.2.0 ; python_version >= "3.8" and python_version < "3.12"
101-
pylint==2.17.4 ; python_version >= "3.8" and python_version < "3.12"
103+
pylint==2.17.5 ; python_version >= "3.8" and python_version < "3.12"
102104
pynmea2==1.19.0 ; python_version >= "3.8" and python_version < "3.12"
103105
pyparsing==3.0.9 ; python_version >= "3.8" and python_version < "3.12"
104106
pytest-cov==4.1.0 ; python_version >= "3.8" and python_version < "3.12"
@@ -110,7 +112,7 @@ pytz==2023.3 ; python_version >= "3.8" and python_version < "3.12"
110112
pywin32==306 ; sys_platform == "win32" and platform_python_implementation != "PyPy" and python_version >= "3.8" and python_version < "3.12"
111113
pywinpty==2.0.11 ; python_version >= "3.8" and python_version < "3.12" and os_name == "nt"
112114
pyyaml==6.0.1 ; python_version >= "3.8" and python_version < "3.12"
113-
pyzmq==25.1.0 ; python_version >= "3.8" and python_version < "3.12"
115+
pyzmq==24.0.1 ; python_version >= "3.8" and python_version < "3.12"
114116
qtconsole==5.4.3 ; python_version >= "3.8" and python_version < "3.12"
115117
qtpy==2.3.1 ; python_version >= "3.8" and python_version < "3.12"
116118
referencing==0.30.0 ; python_version >= "3.8" and python_version < "3.12"
@@ -139,8 +141,8 @@ stack-data==0.6.2 ; python_version >= "3.8" and python_version < "3.12"
139141
tenacity==8.2.2 ; python_version >= "3.8" and python_version < "3.12"
140142
terminado==0.17.1 ; python_version >= "3.8" and python_version < "3.12"
141143
tinycss2==1.2.1 ; python_version >= "3.8" and python_version < "3.12"
142-
tomli==2.0.1 ; python_version >= "3.8" and python_full_version <= "3.11.0a6"
143-
tomlkit==0.11.8 ; python_version >= "3.8" and python_version < "3.12"
144+
tomli==2.0.1 ; python_version >= "3.8" and python_version < "3.11"
145+
tomlkit==0.12.1 ; python_version >= "3.8" and python_version < "3.12"
144146
tornado==6.3.2 ; python_version >= "3.8" and python_version < "3.12"
145147
tqdm==4.65.0 ; python_version >= "3.8" and python_version < "3.12"
146148
traitlets==5.9.0 ; python_version >= "3.8" and python_version < "3.12"

‎gnss_lib_py/utils/ephemeris_downloader.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ def _get_rinex_extension(timestamp):
707707
"""Get file extension of rinex file based on timestamp.
708708
709709
GPS and Glonass Rinex files switched from .Z to .gz on
710-
December 1, 2020 [4]_.
710+
December 1, 2020 [5]_.
711711
712712
Parameters
713713
----------
@@ -721,7 +721,7 @@ def _get_rinex_extension(timestamp):
721721
722722
References
723723
----------
724-
.. [4] https://cddis.nasa.gov/Data_and_Derived_Products/GNSS/daily_30second_data.html
724+
.. [5] https://cddis.nasa.gov/Data_and_Derived_Products/GNSS/daily_30second_data.html
725725
726726
"""
727727
# switched from .Z to .gz compression format on December 1st, 2020

‎notebooks/tutorials/sv_models.ipynb‎

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
{
22
"cells": [
33
{
4-
"attachments": {},
54
"cell_type": "markdown",
65
"metadata": {},
76
"source": [
@@ -11,7 +10,6 @@
1110
]
1211
},
1312
{
14-
"attachments": {},
1513
"cell_type": "markdown",
1614
"metadata": {},
1715
"source": [
@@ -22,15 +20,13 @@
2220
]
2321
},
2422
{
25-
"attachments": {},
2623
"cell_type": "markdown",
2724
"metadata": {},
2825
"source": [
2926
"## Adding SV states to `NavData` with received measurements using broadcast ephemeris"
3027
]
3128
},
3229
{
33-
"attachments": {},
3430
"cell_type": "markdown",
3531
"metadata": {},
3632
"source": [
@@ -52,7 +48,6 @@
5248
]
5349
},
5450
{
55-
"attachments": {},
5651
"cell_type": "markdown",
5752
"metadata": {},
5853
"source": [
@@ -67,7 +62,6 @@
6762
]
6863
},
6964
{
70-
"attachments": {},
7165
"cell_type": "markdown",
7266
"metadata": {},
7367
"source": [
@@ -89,7 +83,6 @@
8983
]
9084
},
9185
{
92-
"attachments": {},
9386
"cell_type": "markdown",
9487
"metadata": {},
9588
"source": [
@@ -118,7 +111,6 @@
118111
]
119112
},
120113
{
121-
"attachments": {},
122114
"cell_type": "markdown",
123115
"metadata": {},
124116
"source": [
@@ -175,11 +167,10 @@
175167
"gps_all_sats = [f\"G{sv:02}\" for sv in range(1, 33)]\n",
176168
"\n",
177169
"# Download ephemeris files for given time\n",
178-
"ephem_all_sats = glp.get_time_cropped_rinex(start_time, gps_all_sats, ephemeris_directory=\"ephemeris\")"
170+
"ephem_all_sats = glp.get_time_cropped_rinex(start_gps_millis, gps_all_sats, ephemeris_directory=\"ephemeris\")"
179171
]
180172
},
181173
{
182-
"attachments": {},
183174
"cell_type": "markdown",
184175
"metadata": {},
185176
"source": [
@@ -199,7 +190,6 @@
199190
]
200191
},
201192
{
202-
"attachments": {},
203193
"cell_type": "markdown",
204194
"metadata": {},
205195
"source": [
@@ -229,15 +219,13 @@
229219
]
230220
},
231221
{
232-
"attachments": {},
233222
"cell_type": "markdown",
234223
"metadata": {},
235224
"source": [
236225
"## Finding PRNs and states for visible SVs for a given position and time"
237226
]
238227
},
239228
{
240-
"attachments": {},
241229
"cell_type": "markdown",
242230
"metadata": {},
243231
"source": [
@@ -269,15 +257,13 @@
269257
]
270258
},
271259
{
272-
"attachments": {},
273260
"cell_type": "markdown",
274261
"metadata": {},
275262
"source": [
276263
"## Finding SV states at given time and for specific PRNs"
277264
]
278265
},
279266
{
280-
"attachments": {},
281267
"cell_type": "markdown",
282268
"metadata": {},
283269
"source": [
@@ -321,15 +307,13 @@
321307
]
322308
},
323309
{
324-
"attachments": {},
325310
"cell_type": "markdown",
326311
"metadata": {},
327312
"source": [
328313
"## Simulating SV positions given elevation and azimuth"
329314
]
330315
},
331316
{
332-
"attachments": {},
333317
"cell_type": "markdown",
334318
"metadata": {},
335319
"source": [
@@ -360,7 +344,7 @@
360344
],
361345
"metadata": {
362346
"kernelspec": {
363-
"display_name": "gnss-lib-py-O-xSxNa6-py3.8",
347+
"display_name": "Python 3 (ipykernel)",
364348
"language": "python",
365349
"name": "python3"
366350
},
@@ -375,8 +359,7 @@
375359
"nbconvert_exporter": "python",
376360
"pygments_lexer": "ipython3",
377361
"version": "3.8.9"
378-
},
379-
"orig_nbformat": 4
362+
}
380363
},
381364
"nbformat": 4,
382365
"nbformat_minor": 2

0 commit comments

Comments
 (0)