Skip to content

Latest commit

 

History

History
84 lines (70 loc) · 4.06 KB

README.md

File metadata and controls

84 lines (70 loc) · 4.06 KB
Raw

OSI Validator

CI

NOTE: This tool is not part of the official OSI standard. It has its own release schedule. The OSI CCB is not responsible for this software but MUST be notified about pull requests.

OSI Validator checks the compliance of OSI messages with predefined rules. These rules can be generated from the OSI .proto files with rules2yml.py. After the rules are generated, they can be customized by the user. The full documentation on the validator and customization of the rules is available here.

Usage

usage: osivalidator [-h] --data DATA [--rules RULES] [--type {SensorView,GroundTruth,SensorData}] [--output OUTPUT] [--timesteps TIMESTEPS] [--debug] [--verbose] [--parallel] [--format {None}]
                    [--blast BLAST] [--buffer BUFFER]

Validate data defined at the input

optional arguments:
  -h, --help            show this help message and exit
  --data DATA           Path to the file with OSI-serialized data.
  --rules RULES, -r RULES
                        Directory with text files containig rules.
  --type {SensorView,GroundTruth,SensorData}, -t {SensorView,GroundTruth,SensorData}
                        Name of the type used to serialize data.
  --output OUTPUT, -o OUTPUT
                        Output folder of the log files.
  --timesteps TIMESTEPS
                        Number of timesteps to analyze. If -1, all.
  --debug               Set the debug mode to ON.
  --verbose, -v         Set the verbose mode to ON.
  --parallel, -p        (Ignored) Set parallel mode to ON.
  --format {None}, -f {None}
                        (Ignored) Set the format type of the trace.
  --blast BLAST, -bl BLAST
                        Set the maximum in-memory storage count of OSI messages during validation.
  --buffer BUFFER, -bu BUFFER
                        (Ignored) Set the buffer size to retrieve OSI messages from trace file. Set it to 0 if you do not want to use buffering at all.

Installation

OSI Validator has been developed with Python 3.8 within a virtual environment on Ubuntu 20.04. See this documentation for Python virtual environments. Check for compatibility with your system the github actions CI workflow. Currently supported are Python 3.8, 3.9, 3.10, 3.11 and 3.12 with the latest Ubuntu version. Check the installation prerequisites of the Open Simulation Interface

Local Linux (recommended)

$ git clone https://github.com/OpenSimulationInterface/osi-validation.git
$ cd osi-validation
$ git submodule update --init
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python3 -m pip install --upgrade pip
(.venv) $ python3 -m pip install -r requirements_develop.txt
(.venv) $ cd open-simulation-interface && python3 -m pip install . && cd ..
(.venv) $ python3 -m pip install -r requirements.txt
(.venv) $ python3 rules2yml.py -d rules
(.venv) $ python3 -m pip install .

Local Windows (Git bash)

$ git clone https://github.com/OpenSimulationInterface/osi-validation.git
$ cd osi-validation
$ git submodule update --init
$ python -m venv .venv
$ source .venv/Scripts/activate
(.venv) $ python -m pip install --upgrade pip
(.venv) $ python -m pip install -r requirements_develop.txt
(.venv) $ cd open-simulation-interface && python -m pip install . && cd ..
(.venv) $ python -m pip install -r requirements.txt
(.venv) $ python rules2yml.py -d rules
(.venv) $ python -m pip install .

Example command

$ osivalidator --data data/20240221T141700Z_sv_300_2112_10_one_moving_object.osi --rules rules/