Skip to content

Commit

Permalink
Clarify use of binaries and resources folder (#1849)
Browse files Browse the repository at this point in the history
* Clarify use of binaries and resources folder
  • Loading branch information
chrbertsch committed Feb 5, 2023
1 parent 7b76a85 commit abf1581
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/2_5_fmu_distribution.adoc
Expand Up @@ -50,7 +50,8 @@ sources // directory containing the C sources (optio
binaries // directory containing the binaries (optional)
x86_64-windows // binaries for Windows on Intel 64-bit
<modelIdentifier>.dll // shared library of the FMI implementation
<other DLLs> // the DLL can include other DLLs
<other files> // other platform dependend files
// needed at linking or loading time
x86-linux // binaries for Linux on Intel 32-bit
<modelIdentifier>.so // shared library of the FMI implementation
aarch32-linux // binaries for Linux on ARM 32-bit
Expand Down Expand Up @@ -84,7 +85,7 @@ The header files `fmi3PlatformTypes.h`, `fmi3FunctionTypes.h` and `fmi3Functions

===== Directory `binaries` [[binaries-directory]]

A binary FMU must contain the binary files for all supported platforms in this folder.
A binary FMU must contain the binary files - that are needed at linking or loading time - of the FMU for all supported platforms in this folder.
To use the binaries of a specific platform, all items in that platform-specific binary folder must be unpacked at the same location as the binary `<modelIdentifier>.{dll|dylib|so}`.

====== Platform Tuple Definition [[platform-tupe-definition]]
Expand Down Expand Up @@ -191,10 +192,14 @@ The requirements and the expected processing must be documented in the `document

In the optional directory `resources`, additional data can be provided in FMU specific formats, typically for tables and maps used in the FMU.
More folders can be added under `resources` (tool/model specific).
For the FMU to access these resource files, the resources directory shall be available in extracted form and the absolute path to this directory is provided via argument <<resourcePath>> of <<fmi3Instantiate>>.
For the FMU to access these resource files - during runtime, after instantiation - the resources directory shall be available in extracted form and the absolute path to this directory is provided via argument <<resourcePath>> of <<fmi3Instantiate>>.
The resources directory must be available for the lifetime of the FMU instance.
The FMU instance must not write to or delete the directory or parts of it.

_[The files contained in the resources folder may be platform dependent files.
In contrast to files in the binaries folder, they can be accessed during runtime by the FMU.
For more information, please consult the https://modelica.github.io/fmi-guides/main/fmi-guide/[FMI Implementer's Guide].]_

===== Directory `extra` [[extra-directory]]

The ZIP archive may contain additional subdirectories within `extra/` that can be used to store additional data, e.g. for the implementation of <<VersioningLayered,layered standards>>.
Expand Down

0 comments on commit abf1581

Please sign in to comment.