AutoFMU - Automatic FMU approximation tool

Building status Documentation Status Coverage status Code style - Black License - MIT

Getting started

Installation

autofmu is distributed as standard pip library, and can be installed by running:

pip install autofmu

Requirements

  • Python>=3.4

  • Docker (optional). Required for cross compilaiton using the bundled Docker image (see: Cross compiler).

Usage

FMU Compilation

By default FMU compilation is disabled, in order to allow the user to fine-tune the compilation process. The C sources are generated in the sources/ folder, and they should be compiled as shared libraries and put in the binaries/ directory at the root of the FMU.

Since FMUs are expected to work seamlessly in multiple plaftorms, autofmu provides two options that allow easy cross compilation of the sources:

--docker-cc

Uses the bundled Docker image to cross-compile the FMU. Generates shared library objects for linux32, linux64, win32 and win64 platforms. Requires a Docker installation.

--remote-cc

Uses the FMU builder server to cross-compile the FMU. Generates shared library objects for all platforms (darwin64, linux32, linux64, win32 and win64). Requires Internet connection.

Tip

None of the above options requires a C compiler installation, so you can use them on any machine that has Docker installed or internet connection.

Contributing

License

This software is distrubuted under MIT license.