GallLeo / fmi-standard

Specification of the Functional Mock-up Interface (FMI)

Functional Mock-up Interface

The Functional Mock-up Interface (FMI) is a free standard that defines an interface to exchange dynamic models using a combination of xml files, binaries and C code. It’s supported by 100+ tools and maintained as a Modelica Association Project.

Repository structure

• docs — sources of the specification document

• headers — C header files

• schema — the XSD schema for the modelDescription.xml

Building the specification document

The FMI specification is written in AsciiDoc, a plain-text mark-up format that can be converted to HTML, DocBook, PDF and other formats. To build the documentation locally

1. Install Ruby

2. Install the AsciiDoctor Ruby gem

3. Clone the repository

   git clone https://github.com/t-sommer/fmi-standard.git

4. Change into the docs folder

   cd docs

5. Generate the HTML document

   asciidoctor -b html5 fmi_specification.adoc

The generated fmi_specification.html can be viewed with any modern web browser.

Copyright and license

Code and documentation copyright © 2008-2011 the MODELISAR consortium and 2012-2018 the Modelica Association Project "FMI". Code released under the BSD License. Docs released under Attribution-ShareAlike 4.0 International.