https://github.com/arthurdjn/gnsstools
Python tools to read and process RINEX, SP3 etc. files, for GNSS management and orbit corrections.
https://github.com/arthurdjn/gnsstools
galileo glonass gnss gps orbit rinex rinex2 rinex3 sp3
Last synced: 5 months ago
JSON representation
Python tools to read and process RINEX, SP3 etc. files, for GNSS management and orbit corrections.
- Host: GitHub
- URL: https://github.com/arthurdjn/gnsstools
- Owner: arthurdjn
- License: mit
- Created: 2021-01-24T22:54:00.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-31T19:09:17.000Z (over 4 years ago)
- Last Synced: 2023-03-10T01:42:17.889Z (over 2 years ago)
- Topics: galileo, glonass, gnss, gps, orbit, rinex, rinex2, rinex3, sp3
- Language: Python
- Homepage:
- Size: 1.56 MB
- Stars: 12
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[]()
[](/LICENSE)
---
Process RINEX, SP3 and other GNSS files for orbit computation and geo-localization. Retrieve precise satellites and receptors position in a few lines of code.
## Table of Contents
- [About](#about)
- [Documentation](#documentation)
- [Getting Started](#getting_started)
- [GNSS Time](#gnsstime)
- [Rinex](#rinex)
- [Satellites](#satellites)
- [Contributing](../CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
### Overview
This project will help you in your GNSS workflow. It provides tools for manipulating / converting GNSS dates (from datetime to Julian Day), readers for ``RINEX`` and ``SP3`` for version 2 and 3.
Last but not least, ``gnsstools`` lets you correct GNSS orbits from raw files, and compute receptors' position.
### Status
| Development | Status | Feature |
| ---------------------------- | ----------- | ---------------------------------------------------------------------- |
| GNSS Time | finished |
- [x] DateTime
- [x] GPS Time
- [x] Julian Day
- [x] Modified Julian Day
| Rinex | in progress |
- [x] Rinex Observation
- [x] Rinex Navigation
- [x] SP3
- [ ] Rinex Compact
| Satellites | in progress |
- [ ] Position
- [ ] Clock Offset
- [ ] Pseudo Distance
### Read The Docs
The documentation is available online on [readthedocs](https://gnsstools.readthedocs.io/en/latest/). You will find the code documentation of the whole package, examples and tutorials. Make sure you have read the documentation before opening an issue.
### Tutorials
In addition of the examples and tutorials available on [readthedocs](https://gnsstools.readthedocs.io/en/latest/),
there is a list of [jupyter notebooks](notebooks). Each one focuses on a specific topic: [reading files](notebooks/),
[retrieving orbits](notebooks/), [computing receptor's position](notebooks) etc.
These instructions will show you the steps on how to install and use ``gnsstools`` straight from the box.
### Installing
The package is available from [PyPi](https://pypi.org/project/gnsstools/). To install it, use:
```
pip install gnsstools
```
Alternatively, you can install the latest version from this repository. [Download](https://github.com/arthurdjn/gnsstools/archive/main.zip) the package from github, then from the root folder:
```
python install .
```
To handles and convert time in different time system you should use the module ``gnsstime``. It will create a time in the ``datetime.datetime`` format, and also process the provided arguments.
### Usage
The ``gnsstime`` object behave exactly like a ``datetime`` one, as it inherits from it.
```python
from gnsstools import gnsstime
# Create a datetime from GNSS information
# Year, Month, Day, Hour, Minute, Second, MicroSecond
date = gnsstime(18, 1, 1, 0, 0, 0)
date = gnsstime(2018, 1, 1, 0, 0, 0)
```
However, the ``gnsstime`` is not type sensitive: you can provide arguments as a ``string``, ``float`` or ``int``.
If the argument is a string, it will convert it first as a float. Then, depending on the argument, it will extract the decimal and update the other arguments.
For example, if ``second=5.35``, the number of seconds will be ``5`` and the number of microsecond ``350000``. Same for ``day=2.74`` etc.
```python
# Provide arguments as a string
date = gnsstime("18", "1", "1", "0", "0", "0")
date = gnsstime("2018", "01", "01", "00", "00", "00.000000")
# Provide argument as a float
date = gnsstime(2018, 1, 1, 5.933, 4.36, 33.231)
```
You can also retrieve the number of days of the year, seconds of the day / weeks etc:
```python
date = gnsstime(2018, 1, 1, 0, 0, 0)
doy = date.doy # Day of the year
woy = date.woy # Week of the year
sod = date.sod # Second of the day
sow = date.sow # Second of the week
```
### GPS Time
You can retrieve the number of seconds, days and weeks from a the GPS origin (*GPS0*) with:
```python
date = gnsstime(2018, 1, 1, 0, 0, 0)
# From GPS0 defined at 1980-01-06T00:00:00 (UTC)
seconds0 = date.seconds0
days0 = date.days0
weeks0 = date.weeks0
```
### Julian Day
You can also retrieved the Julian Day:
```python
date = gnsstime(2000, 1, 1, 0, 0, 0)
# Julian Day for year 2000
jd = date.jd
# Julian Day for year 1950
jd50 = date.jd50
```
You can also create a ``gnsstime`` object from a Julian Day:
```python
jd = 2451545.0
date = gnsstime.fromjd(jd)
jd50 = 2433282.5
date = gnsstime.fromjd50(jd50)
```
### Modified Julian Day
Finally, you can extract modified Julian Day:
```python
date = gnsstime(2000, 1, 1, 0, 0, 0)
# Modified Julian Day
mjd = date.mjd
```
Again, you can create a ``gnsstime`` object from a modified Julian Day:
```python
mjd = 51544.5
date = gnsstime.frommjd(mjd)
```
Load GNSS navigation and observation data as a ``pandas.DataFrame``.
The supported format are:
- ``.**o`` : Rinex 2 Observation,
- ``*O.rnx`` : Rinex 3 Observation,
- ``.**n``, ``.**g`` : Rinex 2 Navigation,
- ``*N.rnx`` : Rinex 3 Navigation,
- ``.SP3`` : SP3
### Observation
```python
from gnsstools import rinex
filename = "data/edf1285b.18o"
df = rinex.load(filename)
```
### Navigation
```python
from gnsstools import rinex
filename = "data/BRDC00IGS_R_20182850000_01D_MN.rnx"
df = rinex.load(filename)
```
Once loaded, you select an ephemeris / satellite for a specific date with:
```python
from gnsstools import gnsstime
date = gnsstime(2018, 10, 12, 0, 40, 15)
satellite = df.select("G", 2, date)
```
If ``date`` is not part of the dataset ``df``, it will return the closest satellite.
### SP3
```python
from gnsstools import rinex
filename = "data/COM20225_15M.SP3"
df = rinex.load(filename)
```
### Compact
*Work in Progress*
*Work in Progress*
- Hat tip to anyone whose code was used
- Inspiration
- References