Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix outdated documentation on formatting scripts #803

Merged
merged 1 commit into from
May 6, 2024
Merged

Fix outdated documentation on formatting scripts #803

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions doc/architecture/formatting_scripts.adoc → doc/architecture/formatting_script.adoc
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion doc/open-simulation-interface_user_guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
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