Python SDK for Jason GNSS Cloud PPK Service
Jason GNSS Cloud PPK Service is a cloud-based positioning engine that uses GNSS data. One of the main features of this service is that offers an API so that users can automatize the GNSS data processing without the need to access the front-end.
The online documentation of the service can be found here.
To install the package:
pip3 install jason-gnss
Note that this SDK supports only Python 3.x.
Authentication
It is important that you have the JASON_API_KEY and JASON_SECRET_TOKEN
environement variables. These can be fetched by accessing your area in the
Jason PaaS and then going to My Account -> API Credentials.
Use the package as an SDK
The package is basically a library that can be embedded into your Python scripts
import jason_gnss as jason
# Submit a process without waiting for it to finish (fetch it later)
jason.submit_process(rover_file)
# ({'message': 'success', 'id': 3505}, 200)
# Get the status of your process. The documentation of the return can
# be found in the Jason online documentation
process_id = 3505
jason.get_status(process_id)
# ({'process': {'id': 3505, ...}, 200)
# Download the results file for a given process that you own
jason.download_results(process_id)
# '/jason_gnss/rokubun_gnss_id_003505.zip'
Command line tools
The package has also a command line tool so that you can use it out-of-the-box. The following examples illustrate how to use it.
export JASON_API_KEY='<jason-api-key>'
export JASON_SECRET_TOKEN='<your-private-jason-user-token>'
# Get the help
jason -h
# Process a rover file
jason process test/jason_gnss_test_file_rover.txt
# Process a rover file and adding a base station file as well
jason process test/jason_gnss_test_file_rover.txt test/jason_gnss_test_file_base.txt
# Perform a PPK processing specifying a rover, base file as well as the location
# of the base station
jason process test/jason_gnss_test_file_rover.txt \
test/jason_gnss_test_file_base.txt \
--base_position 41.809142804 2.163228514 936.01730
# Get the status of a process
jason status process_id
# Fetch the results file for a given process id
jason download process_id
# Convert a file to RINEX 3.03 format
jason convert test/jason_gnss_test_file_smartphone.txt
The arguments of the command line tools follow the docopt
Docker execution/development
It is recommended that you use docker to execute or work with this package.
This repository contains both a Dockerfile as well as a docker-compose.yml
to help you with this.
Follow these instructions:
# Command to build the image
docker-compose build
# Start the container with the package loaded with the command
docker-compose run jason_gnss
Once inside the container:
# Install the package
python setup.py install
Now, while in the container, you can issue commands in the prompt or within the Python console.
API Key and secret token
If you are using docker-compose, we recommend that you store your authorization
keys in a file .env and run the Docker container via the command
docker-compose run jason-gnss. With this, your credentials will be loaded
in the container and the Jason tools will be ready to use without the need
to declare these variables.
JASON_API_KEY='<jason-api-key>'
JASON_SECRET_TOKEN='<your-private-jason-user-token>'
Although probably not used for the end user, for debugging purposes, in the
event that you have a local instance of the Jason service running in your
facilities, you can set the Jason entry point by defining the JASON_API_URL
environment variable.
1 maintainer
Metadata
1 maintainer
Release files for jason-gnss 1.13.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| jason-gnss-1.13.1.tar.gz | 12.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jason_gnss-1.13.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 24.2 kB
Release files / jason-gnss-1.13.1.tar.gz
| Download URL | jason-gnss-1.13.1.tar.gz |
|---|---|
| Size | 12.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2f94e26d5349c862c07ceafa182045539567feeda4fdcc6356e7e26ceb2175cf
|
|
BLAKE2b-256 checksum How to use checksums |
df763d2b37f8e8ad09e7568edeab7425deb56470e3f256964e28c557b7c2263c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
|
Release files / jason_gnss-1.13.1-py3-none-any.whl
| Download URL | jason_gnss-1.13.1-py3-none-any.whl |
|---|---|
| Size | 11.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6b47879515fb1af690c9430aa7f707a47aff845e3080e56fc3c921184702154d
|
|
BLAKE2b-256 checksum How to use checksums |
63f74c592db9cdd2d57926ac049e87a0f2ad3b86debad4b44a260894a7b631ad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
|
Security for jason-gnss 1.13.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
