Skip to content

Commit

Permalink
Add README.md for examples page, for FMI tools examples reference
Browse files Browse the repository at this point in the history
  • Loading branch information
StephanieKemna committed Dec 19, 2024
1 parent b716bf3 commit 712b83b
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Examples

This folder contains a couple of examples you can look at and test the MLFMU tool with.
Each folder is set up to contain:

* `config`: containing the `.onnx` and `interface.json` files
* `generated_fmu`: binary FMU files, to serve as examples
* `<FmuName>`: source files for the FMU

The FMUs in this folder have been validated using [FMU_check].

For further documentation of the `mlfmu` tool, see [README.md](../README.md) or the [docs] on GitHub pages.

<!-- Markdown link & img dfn's -->
[FMU_check]: https://fmu-check.herokuapp.com/
[docs]: https://dnv-opensource.github.io/mlfmu/

0 comments on commit 712b83b

Please sign in to comment.