BobDyn/BobLib Startup

Use this path when you want to work directly on the Modelica vehicle library: package structure, records, subsystem models, VehicleInterfaces integration, OMEdit diagrams, or direct OpenModelica checks.

Starting point

In this guide, the BobDyn/BobLib root means the repository directory created by the clone step below. Start in that directory before running commands.

What You Need

Install these first:

• Git
• OpenModelica with OMEdit and omc
• Modelica Standard Library 4.1.0
• VehicleInterfaces 2.0.2
• Python and pytest if you want to run the repository checks locally

BobLib can also be consumed through BobSim as a submodule, but clone BobLib directly when you are changing the Modelica layer itself.

Step 1: Clone BobLib

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

The active package is:

BobLib/package.mo

Regression and component fixtures live in Tests/BobLibTest/package.mo.

Step 2: Confirm OpenModelica Libraries

OpenModelica must be able to load:

Modelica 4.1.0
VehicleInterfaces 2.0.2

The easiest visual check is OMEdit: open File > System Libraries and confirm both libraries are installed. For CLI work, use the same OpenModelica install that OMEdit uses.

Step 3: Run Repository Checks

From the BobLib root, run the Python and Modelica coverage checks:

make test

If you are using a repository-local virtual environment, pass it explicitly:

make test PYTHON=.venv/bin/python

These checks keep the public Modelica package, record coverage, and test manifests aligned.

Step 4: Load BobLib In OMEdit

Open the package:

BobLib/package.mo

Start with the standard experiment entry points:

BobLib.Experiments.Standards.VehicleSim
BobLib.Experiments.Standards.FourPostSim

Use the OMEdit Workflow page for the full visual package-load sequence and maintained screenshots.

Step 5: Know The Direct-Use Surface

For daily BobLib work, the main public surfaces are:

Area	Use it for
BobLib.Experiments.Standards	Complete vehicle entry points such as VehicleSim and FourPostSim
BobLib.Records	Vehicle data schemas and complete vehicle definitions
BobLib.Chassis, Aero, ElectricDrives, PowerElectronics, Controllers, Drivelines, EnergyStorage	Vehicle subsystem contracts and BobLib physics implementations
BobLib.Utilities	Shared mechanics, math, FMI, and helper functionality

Next Pages

• BobLib Use Guide for the daily model-development loop
• BobDyn/BobLib Overview for package architecture
• CLI Workflow for direct OpenModelica command-line work
• OMEdit Workflow for visual loading and simulation
• BobSim Startup when you want the full workflow wrapper