Skip to main content

GNSS processing engine benchmarking data set

This repository contains several datasets to compute the performance of a GNSS processing engine. This repository has been developed to help Rokubun Jason users to assess the expected performance of the platform. However, the orchestrator can be also used to test your own engine.

The repository includes also a tool to run the complete pipeline. To do that, simply use these commands:

pip install gnss-benchmark
gnss_benchmark make_report

This tool will take a while to process (ca. 5 minutes), and after that a PDF report should have been generated.

Note that if you do not have LaTEX installed in your system you may not be able to generate the report in PDF. In this case, you can try other formats such as LibreOffice ODT. To do that type

gnss_benchmark make_report --filename report.odt

Use the help of the tool to get more information

gnss_benchmark -h

Running and developing in a container

To make sure you have all necessary components in the system, you can work using Docker containers (recommended).

The first step would be to build the container

docker build -t gnss-benchmark .
# Usage with docker run
docker run -v `pwd`:/gnss_benchmark -w /gnss_benchmark -ti gnss-benchmark bash

# Development with Jupyter
docker run --env-file .env -v `pwd`:/data -w /data -p 8888:8888 -ti gnss-benchmark jupyter notebook

# Usage with docker compose (recommended)
docker-compose -f docker-compose.yml build
docker-compose -f docker-compose.yml run gnss_benchmark bash
python setup.py install
gnss_benchmark make_report -l DEBUG

When using docker-compose remember to place your Jason credentials in an .env file with these contents:

JASON_API_KEY=<api key>
JASON_SECRET_TOKEN=<your secret token>

Although probably not used for the end user, just 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 (along with its corresponding credentials). As an example:

JASON_API_URL=http://192.168.1.54:10000/api
JASON_API_KEY=<api key>
JASON_SECRET_TOKEN=<your secret token>

Using custom processing engine

By default, the tool comes bundled with Rokubun Jason's processing engine, but the user can specify its own processing engine. This cannot be done with the command line tool: a custom Python code will have to be made using the gnss_benchmark module. In this module, there is a package named jason with an example of processing_engine that the user can follow to define other processing engines.

Metadata

Release files for gnss-benchmark 2.0.0.post12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gnss-benchmark 2.0.0.post12
File Size Uploaded Provenance
gnss-benchmark-2.0.0.post12.tar.gz 46.6 MB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for gnss-benchmark 2.0.0.post12
File Interpreter ABI Platform
gnss_benchmark-2.0.0.post12-py3-none-any.whl Python 3 none any Details

Total release size: 95.2 MB

Release files / gnss-benchmark-2.0.0.post12.tar.gz

Download URL gnss-benchmark-2.0.0.post12.tar.gz
Size 46.6 MB
Tags Source
SHA-256 checksum
How to use checksums
461458f994ed57a108c478701ab789d84350e6b77ce44ca0e66f7bad78884275
BLAKE2b-256 checksum
How to use checksums
5631deaeacc9cb2ff870aea2becfba905d7b35850e87fdc811be63aa9a65bbe8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0

Release files / gnss_benchmark-2.0.0.post12-py3-none-any.whl

Download URL gnss_benchmark-2.0.0.post12-py3-none-any.whl
Size 48.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
3901718ea3ad01547706d2d34593358c24aa44ab1da58398082680a7e6642df3
BLAKE2b-256 checksum
How to use checksums
b635ad36aeb01709902d73df9aa1dbdec5d449da03cb3b347b714b21ff885721
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0

Security for gnss-benchmark 2.0.0.post12

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page