|
| 1 | +<picture> |
| 2 | + <source media="(prefers-color-scheme: dark)" srcset="docs/images/FMI-logo-horizontal-dark.svg"> |
| 3 | + <source media="(prefers-color-scheme: light)" srcset="docs/images/FMI-logo-horizontal-light.svg"> |
| 4 | + <img alt="Functional Mock-up Interface" src="docs/images/FMI-logo-horizontal-light.svg"> |
| 5 | +</picture> |
| 6 | + |
| 7 | +# Functional Mock-up Interface |
| 8 | + |
| 9 | +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. |
| 10 | +It's supported by [240+ tools](https://fmi-standard.org/tools/) and maintained as a [Modelica Association Project](https://modelica.org/projects). |
| 11 | + |
| 12 | +Releases and the [latest development version](https://fmi-standard.org/docs/main/) of the specification are available on the [FMI website](https://fmi-standard.org/). |
| 13 | + |
| 14 | +## Repository Structure |
| 15 | + |
| 16 | +- [docs](docs) — sources of the specification document |
| 17 | +- [headers](headers) — header files of the C-API |
| 18 | +- [schema](schema) — XSD schema for the modelDescription.xml |
| 19 | +- [CONTRIBUTING.md](CONTRIBUTING.md) — info on contributing to the project and building the specification document |
| 20 | +- [README.md](README.md) — this document |
| 21 | + |
| 22 | +## Branches |
| 23 | + |
| 24 | +- `main` — development of the next release |
| 25 | +- `v{2|3}.0.x` — maintenance of the 2.0 and 3.0 releases |
| 26 | + |
| 27 | +## Layered Standards |
| 28 | + |
| 29 | +The following [layered standards](https://github.com/modelica/fmi-standard/blob/main/docs/2_6_versioning_layered_standards.adoc#versioning-and-layered-standards) are currently under development: |
| 30 | + |
| 31 | +- [XCP](https://github.com/modelica/fmi-ls-xcp) — information for calibration and measurement |
| 32 | +- [Network Communication](https://github.com/modelica/fmi-ls-bus) — mapping of variables to buses |
| 33 | +- [Structure](https://github.com/modelica/fmi-ls-struct) — semantic grouping of variables |
| 34 | +- [REF](https://github.com/modelica/fmi-ls-ref) — stimuli and reference results |
| 35 | + |
| 36 | +## Copyright and License |
| 37 | + |
| 38 | +Code and documentation copyright © 2008-2011 the MODELISAR consortium and 2012-2025 the Modelica Association Project FMI. |
| 39 | +Code released under the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause). |
| 40 | +Docs released under [Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/). |
0 commit comments