Skip to content

Commit

Permalink
Fix outdated documentation on formatting scripts
Browse files Browse the repository at this point in the history
Signed-off-by: Thomas Sedlmayer <tsedlmayer@pmsfit.de>
  • Loading branch information
thomassedlmayer committed Apr 22, 2024
1 parent 560d23a commit 5373884
Showing 1 changed file with 4 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ ifndef::include-only-once[]
:root-path: ../
include::{root-path}_config.adoc[]
endif::[]
= Trace-file formatting scripts
= Trace-file formatting script

The OSI repository contains Python scripts for converting trace files from one format to another.
The formatting scripts are stored in `open-simulation-interface/format/`
The OSI repository contains a Python script for converting trace files from one format to another.
The formatting script is stored in `open-simulation-interface/osi3trace/`.

**osi2read.py**

Expand All @@ -22,12 +22,7 @@ The default value is `'SensorView'`.

`--output`, `-o`::
Optional string containing the name of the output file.
The default value is `'converted.txth'`.

`--format`, `-f`::
Optional string containing the format type of the trace file.
`'separated'`, or `None` are permitted values.
The default value is `None`.
The default value is `None`, in which case the output file name is set to the name of the input file, with the file extension being replaced by `.txth`.

**Related topics**

Expand Down

0 comments on commit 5373884

Please sign in to comment.