README.md

Dynamic Simulation Environment - C Library

Introduction

Shared C Library of the Dynamic Simulation Environment (DSE) Core Platform.

Project Structure

L- docker       Supporting build environments.
L- dse/clib     C Library source code.
L- examples     Example usage of the C Library.
L- extra        Build infrastructure.
L- licenses     Third Party Licenses.
L- tests        Unit and integration tests.

Usage

Toolchains

The C Library is built using containerised toolchains. These can be built as follows:

$ git clone https://github.com/boschglobal/dse.clib.git
$ cd dse.clib
$ make docker
...
$ docker images
REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
clang-format        latest              1383c4b9a6ff        4 minutes ago       422MB
flatc-builder       latest              ae386cde1022        4 days ago          588MB
gcc-builder         latest              3654f9a45978        4 minutes ago       1.81GB
python-builder      latest              1ab91b4bef07        4 weeks ago         1.21GB

Alternatively, the latest Docker Images are available on ghcr.io and can be used as follows:

$ export GCC_BUILDER_IMAGE=ghcr.io/boschglobal/dse-gcc-builder:main

Build

# Get the repo
$ git clone https://github.com/boschglobal/dse.clib.git
$ cd dse.clib

# Optionally set builder images.
$ export GCC_BUILDER_IMAGE=ghcr.io/boschglobal/dse-gcc-builder:main

# Build (downloads dependencies needed for running tests).
$ make

# Run tests.
$ make test

# Remove (clean) temporary build artifacts.
make clean

Contribute

Please refer to the CONTRIBUTING.md file.

License

Dynamic Simulation Environment C Library is open-sourced under the Apache-2.0 license. See the LICENSE and NOTICE files for details.

Third Party Licenses

Third Party Licenses