From 20298f14a29ce1f8fe8ccc7d4644928def29322a Mon Sep 17 00:00:00 2001 From: Robin Andersson Date: Thu, 26 Oct 2023 08:18:18 -0400 Subject: [PATCH] Update README.md (#204) --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 40a65314..01ae5a44 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,15 @@ -PyFMI -===== +About +----------- PyFMI is a package for loading and interacting with Functional Mock-Up Units (FMUs) both for Model Exchange and Co-Simulation, which are compiled dynamic -models compliant with the Functional Mock-Up Interface (FMI). See - https://fmi-standard.org/ for more -information. +models compliant with the Functional Mock-Up Interface ([FMI](https://fmi-standard.org/)). -For a more indebt technical description of the features / functionality see: -https://portal.research.lu.se/portal/files/7201641/pyfmi_tech.pdf +For a more indebt technical description of the features / functionality see the following [link](https://portal.research.lu.se/portal/files/7201641/pyfmi_tech.pdf). For citing PyFMI, please use: -Andersson, C, Åkesson, J & Führer, C 2016, PyFMI: A Python Package for Simulation of Coupled Dynamic Models with the Functional Mock-up Interface. Technical Report in Mathematical Sciences, nr. 2, vol. 2016, vol. LUTFNA-5008-2016, Centre for Mathematical Sciences, Lund University. +Andersson, C, Åkesson, J & Führer, C 2016, PyFMI: A Python Package for Simulation of Coupled Dynamic Models with the Functional Mock-up Interface. Technical Report in Mathematical Sciences, nr. 2, vol. 2016, vol. LUTFNA-5008-2016, Centre for Mathematical Sciences, Lund University. For information about contributing, see [here](https://github.com/modelon/contributing). @@ -32,3 +29,14 @@ Installation using CONDA Note that some examples requires optional dependencies for plotting, they are: - wxPython - matplotlib + +FMU Import Compliance +----------- +PyFMI is tested daily in several different ways: +* Extensive external testing within the `Optimica Compiler Toolkit` (OCT) provided by [Modelon](https://help.modelon.com/latest/reference/oct/) using all models in Modelon Modelica libararies (35000+ models), exported as FMUs. +* Unit tests from the `tests` directory. These use FMUs generated by + * OCT + * JModelica.org + * FMUs in the example directory are generated via FMU SDK by Qtronic, more information is available in related `README.txt` for these FMUs with proper license text. +* PyFMI is the default execution engine for [Modelon Impact](https://modelon.com/modelon-impact/). +* Some testing with Dymola FMUs and FMUs from [FMI Cross Check](https://github.com/modelica/fmi-cross-check).