Skip to content

Commit

Permalink
Merge pull request #803 from thomassedlmayer/fix/osi3trace_documentation
Browse files Browse the repository at this point in the history
Fix outdated documentation on formatting scripts
  • Loading branch information
pmai committed May 6, 2024
2 parents f479d99 + f4fce53 commit e64338c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 10 deletions.
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
2 changes: 1 addition & 1 deletion doc/open-simulation-interface_user_guide.adoc
Expand Up @@ -69,7 +69,7 @@ include::./architecture/trace_file_naming.adoc[leveloffset=+3]

include::./architecture/trace_file_example.adoc[leveloffset=+3]

include::./architecture/formatting_scripts.adoc[leveloffset=+3]
include::./architecture/formatting_script.adoc[leveloffset=+3]


// Setting up OSI
Expand Down

0 comments on commit e64338c

Please sign in to comment.