BobDyn/BobLib Setup

BobDyn/BobLib can be used directly as a standalone Modelica package, or indirectly as the BobLib submodule inside BobSim. For model development and debugging, clone BobLib directly.

Get BobLib Source

Clone BobLib directly and continue from the repository root:

git clone https://github.com/BobDyn/BobLib.git
cd BobLib

In the rest of the BobLib docs, "repository root" means this BobLib directory, which contains the production package, test package, Python harness, and helper make targets:

BobLib/package.mo
Tests/BobLibTest/package.mo
Tests/
makefile
msl_setup.mos

BobLib/package.mo is the production Modelica package. Tests/BobLibTest is the sibling Modelica package for regression and component fixtures.

OpenModelica Prerequisites

For CLI use, install:

• omc available on PATH
• a C/C++ compiler toolchain usable by OpenModelica
• Modelica Standard Library 4.1.0
• VehicleInterfaces 2.0.2

For OMEdit use, install the full OpenModelica GUI stack, not only the compiler.

Useful official OpenModelica links:

• OpenModelica downloads
• Linux package install
• Windows installer
• macOS notes
• OMEdit user guide

Install the expected Modelica Standard Library package:

make modelica-deps

That target runs omc msl_setup.mos. VehicleInterfaces 2.0.2 must also be installed in the OpenModelica package manager for BobLib checks.

Verify:

omc --version

Python Environment

Python is required for the regression harness. Create a local environment:

python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install pytest ruff

On Windows PowerShell:

.\.venv\Scripts\Activate.ps1

Verify:

python --version
python -c "import pytest; print('ok')"

First Health Check

Run the full local release gate:

make test PYTHON=.venv/bin/python

For a smaller first check:

make modelica-translation PYTHON=.venv/bin/python
python -m pytest Tests/test_boblib_modelica.py

The full test target verifies BobLib standards plus the Tests/BobLibTest regression and component fixtures.

BobSim Submodule Path

When BobLib is used inside BobSim, it lives at:

_0_Utils/external/BobLib/

In that workflow, BobSim consumes BobLib as a static Modelica library. Vehicle architecture data is moving into checked-in Modelica records rather than a Python/YAML generation step.