Merge branch 'master' into 64-validating-a-yml-rule

Signed-off-by: ClemensLinnhoff <[email protected]>

Author: ClemensLinnhoff

.github/workflows/ci.yml

@@ -48,42 +48,20 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v4
       with:
+        submodules: recursive
         lfs: true
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Cache Dependencies
-      id: cache-depends
-      uses: actions/cache@v3
-      with:
-        path: protobuf-3.20.1
-        key: ${{ runner.os }}-v2-depends
-
-    - name: Download ProtoBuf
-      if: steps.cache-depends.outputs.cache-hit != 'true'
-      run: curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.20.1/protobuf-all-3.20.1.tar.gz && tar xzvf protobuf-all-3.20.1.tar.gz
-
-    - name: Build ProtoBuf
-      if: steps.cache-depends.outputs.cache-hit != 'true'
-      working-directory: protobuf-3.20.1
-      run: ./configure DIST_LANG=cpp --prefix=/usr && make
-
-    - name: Install ProtoBuf
-      working-directory: protobuf-3.20.1
-      run: sudo make install && sudo ldconfig
-
-    - name: Install Open Simulation Interface
-      shell: bash
+    - name: Set up Virtual Environment
       run: |
-        git submodule update --init
         python -m venv .venv
         source .venv/bin/activate
         python -m pip install --upgrade pip
         pip install -r requirements_develop.txt
-        cd open-simulation-interface && pip install . && cd .. 
 
     - name: Generate parsed rules
       run: |
@@ -100,7 +78,5 @@ jobs:
       run: |
         source .venv/bin/activate
         pip install .
-        osivalidator --data data/20210818T150542Z_sv_312_50_one_moving_object.txt -r rules
-        osivalidator --data data/20210818T150542Z_sv_312_50_one_moving_object.txt -r rules --parallel
-        osivalidator --data data/20210818T150542Z_sv_312_50_one_moving_object.osi -r rules
-        osivalidator --data data/20210818T150542Z_sv_312_50_one_moving_object.osi -r rules --parallel
+        osivalidator --data data/20240221T141700Z_sv_300_2112_10_one_moving_object.osi -r rules
+        osivalidator --data data/20240221T141700Z_sv_300_2112_10_one_moving_object.osi -r rules --parallel

README.md

@@ -3,12 +3,15 @@
 
 > **_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](https://github.com/OpenSimulationInterface/osi-validation/tree/master/rules). The full documentation on the validator and customization of the rules is available [here](https://github.com/OpenSimulationInterface/osi-validation/tree/master/doc).
+OSI Validator checks the compliance of OSI messages with predefined rules.
+These rules can be generated from the OSI .proto files with [rules2yml.py](https://github.com/OpenSimulationInterface/osi-validation/blob/master/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](https://github.com/OpenSimulationInterface/osi-validation/tree/master/doc).
 
 ## Usage
 
 ```bash
-usage: osivalidator [-h] [--data DATA] [--rules RULES] [--type {SensorView,GroundTruth,SensorData}] [--output OUTPUT] [--timesteps TIMESTEPS] [--debug] [--verbose] [--parallel] [--format {separated,None}]
+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
@@ -26,13 +29,13 @@ optional arguments:
                         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        Set parallel mode to ON.
-  --format {separated,None}, -f {separated,None}
-                        Set the format type of the trace.
+  --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 in-memory storage count of OSI messages during validation.
+                        Set the maximum in-memory storage count of OSI messages during validation.
   --buffer BUFFER, -bu BUFFER
-                        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.
+                        (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
@@ -77,5 +80,5 @@ $ source .venv/Scripts/activate
 ## Example command
 
 ```bash
-$ osivalidator --data data/20210818T150542Z_sv_312_50_one_moving_object.txt --rules rules/
+$ osivalidator --data data/20240221T141700Z_sv_300_2112_10_one_moving_object.osi --rules rules/
 ```