Metadata-Version: 2.4
Name: osi-python
Version: 3.8.0
Summary: ASAM Open Simulation Interface Python Bindings.
License: MPL-2.0
License-File: LICENSE
Author: ASAM Open Simulation Interface Project
Author-email: osi@asam.net
Maintainer: ASAM Open Simulation Interface Project
Maintainer-email: osi@asam.net
Requires-Python: >=3.10
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: mcap (>=1.2.2)
Requires-Dist: mcap-protobuf-support (>=0.5.3)
Requires-Dist: protobuf (>=6.30.2)
Requires-Dist: typing-extensions (>=4.9,<5.0)
Project-URL: Bug Tracker, https://github.com/OpenSimulationInterface/osi-python/issues
Project-URL: Homepage, https://github.com/OpenSimulationInterface/osi-python
Project-URL: Repository, https://github.com/OpenSimulationInterface/osi-python.git
Description-Content-Type: text/markdown

Open Simulation Interface (OSI) Python Bindings
===============================================

This python package provides python bindings and utility modules for the [ASAM Open Simulation Interface](https://github.com/OpenSimulationInterface/open-simulation-interface).

For more information on OSI see the [official documentation](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/index.html) or the [class list](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/gen/annotated.html) for defined protobuf messages.

Usage
-----

For usage examples, please refer to the official documentation:

- [Trace file generation with python](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/architecture/trace_file_example.html)

Installation
------------

### Installing from source

#### Prerequisites

- You have installed Python 3.10 or later.
- You have installed _pip_.

#### Steps

- Open a terminal.
- Clone the osi-python repository, including sub-modules:

  ```console
  git clone --recurse-submodules https://github.com/OpenSimulationInterface/osi-python.git
  ```

- Switch to the repository directory:

  ```console
  cd osi-python
  ```

- Optionally create and activate a new virtual environment:

  ```console
  python3 -m venv venv
  source venv/bin/activate
  ```

- Install the package:

  ```console
  pip install .
  ```

