The following table lists the build results of the last daily build and manual. These builds are all done using the master branch of all repos.

Build Type	Variant	Failed
linux64-dailydebug	build	/
linux64-dailydebug	examples	/
linux64-dailydebug	coverage
linux64-dailydebug	examples-valgrind	/
linux64-dailydebug	coverage-valgrind
linux64-dailyrelease	build	/
linux64-dailyrelease	examples	/
win64-dailyrelease	build	/
win64-dailyrelease	examples	/
-	manuals	/

This repository holds data (mainly scripts) to build and run the tools of the MBSim-Environement. It contains

A set of Docker files which are used to build Docker images of the MBSim-Environement. These can be used to run or build the MBSim-Environement easily. Dependent of your use case you should use one of the following options.

Note that users of MBSim-Env should just download and install a release of MBSim-Env! This section is for developers who want to build MBSim-Env inside of a Docker image!

Building MBSim-Env from scratch is QUITE complicated since it has many dependencies to other tools. And not all of these tools are available via the package manager of your preferred Linux distribution. Different versions of these dependent tools can also cause a lot of trouble. That's why we provide Docker images to build and run MBSim-Env easily in the typical edit-compile-run cycle. These Docker images are also used for the continuous integration and nightly builds on the official MBSim-Env build system.

To prepare the Docker build the following steps needs to be done once:

1. Install Docker. Please look at Docker or your Linux distribution how to do this. Allow Docker for the user of your choice, e.g. by giving this user access to the Docker socket.
2. Clone this Git repository to your preferred directory (<mypath>) which should have enough space to hold the MBSim-Env source code the build directories as well as all your MBSim-Env models and data (about 10GB).
3. Configure your shell to add <mypath>/build/docker/buildScripts to your PATH. This is not really required but recommended to allow starting programs without typing the full path all the time.
4. Call build.sh in the above configured shell. This will clone all MBSim-Env repositories, if not already done manually, to <mypath>/fmatvec, <mypath>/hdf5serie, ... Then it will download a large Docker image for MBSim-Env (This Docker image is about 3GB. So your Docker image directory will need at least 3GB space). After that it will completely build MBSim-Env. So, take a coffee, this takes some time. The current progress of building MBSim-Env can be checked via your browser. The corresponding URL will be printed at the beginning. Note that running build.sh without any parameters will build everything and also runs the basic examples. See build.sh -h for available options to change this default behavior. Especially useful are all the options -j and --disable* whereas all other options may not be useful in your context.

You are done! Now you can try the examples, build your own models or make code adaptions/extensions and rebuild.

Try the examples in <mypath>/mbsim/examples/xml by running these with mbsimxml and watch the results afterwards with openmbv. Start the GUI of MBSim by running mbsimgui. All other MBSim-Env commands like h5plotserie, ... are also available.

Make adaptions to the source code and rerun build.sh (with proper options to speed up the build) or run make in the corresponding build directory (<mypath>/fmatvec-docker, <mypath>/hdf5serie-docker/hdf5serie, ...) to rebuild your changed code parts.

Run runexamples.sh in the directory <mypath>/mbsim/examples to run and validate examples. See runexamples.sh -h for available options.

For extended use you can run mbsimenv-bash.sh to start an interactive bash inside of the Docker container.

Note that you do not need to have any development tools installed on your host computer (no make, not gcc, ... is required) since everything comes along with the Docker image automatically and consistently.

Note that users of MBSim-Env should just download and install a release of MBSim-Env! This section is for developers who want to build MBSim-Env inside of a Docker image!

You can also build (cross-compile) all MBSim-Env tools for Windows using a Docker image. You can than run the generated Windows executables using Wine on Linux or run these natively on a Windows PC.

To build and run MBSim-Env for Windows just follow the instructions from the previous section but replace in 3. <mypath>/build/docker/buildScripts with <mypath>/build/docker/buildwin64Scripts. The build directories are named <mypath>/fmatvec-dockerwin64, <mypath>/hdf5serie-dockerwin64/hdf5serie, ...

The Docker image for the Windows build is about 8GB.

It is recommended NOT to use the same base directory <mypath> for the Linux and Windows Docker build. This works in principle but causes problems due to different versions of the autotools build tools.

Contains the coding style conventions used in the MBSim-Environement.

Contains some miscellaneous files and scripts (e.g. valgrind suppressions)

Django 3 project of the mbsim server