ASAM OSI Utilities

A utility library that provides essential tools, helper functions, and implementation best practices for working with the ASAM Open Simulation Interface (OSI) standard. This library streamlines OSI data handling and makes integration into applications and simulations easier.

NOTE: The main branch actively tracks and implements the latest OSI specification developments, including promising proposed changes. This project does not feature a stable release targeting a specific OSI version yet!

Features

• Cross-platform C++ library and Python APIs

  • NOTE: Python API is planned but not yet implemented.

  • NOTE: Windows should be supported but not yet tested, contributions welcome!

• Easily integrate dealing with OSI data and trace files into your own projects
• More OSI utility features planned, feature requests and pull requests welcome!

Build Instructions

Install required dependencies

• Compiler (e.g. GCC, Clang, MSVC)
• CMake
• zstd
• lz4
• Protobuf

Note: On Debian/Ubuntu, you can install the required dependencies using the following commands:

sudo apt install build-essential cmake libzstd-dev liblz4-dev protobuf-compiler doxygen

Build

Clone the repository incl. submodules

git clone --recurse-submodules https://github.com/Lichtblick-Suite/asam-osi-utilities.git

Create build directory and configure using CMake

mkdir build && cd build
cmake ..

Build using CMake

cmake --build . -j4

Examples

Check out the examples in the examples folder for usage examples. Further information can be found in the examples/README.md.

Contributing

We welcome contributions! This library aims to grow alongside ASAM OSI to provide the community with helpful tools and utilities. If you have ideas for new features or improvements, you are encouraged to open issues and submit pull requests.