From 712b83b44f79c88554f2d6801580f1190b67149b Mon Sep 17 00:00:00 2001 From: Stephanie Kemna <6518317+StephanieKemna@users.noreply.github.com> Date: Thu, 19 Dec 2024 13:58:54 +0100 Subject: [PATCH] Add README.md for examples page, for FMI tools examples reference --- examples/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..1838a29 --- /dev/null +++ b/examples/README.md @@ -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 +* ``: 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. + + +[FMU_check]: https://fmu-check.herokuapp.com/ +[docs]: https://dnv-opensource.github.io/mlfmu/