Skip to content

Commit

Permalink
Update README.md (#204)
Browse files Browse the repository at this point in the history
  • Loading branch information
modelonrobinandersson authored Oct 26, 2023
1 parent 20c0563 commit 20298f1
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
<em>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</em>.

For information about contributing, see [here](https://github.com/modelon/contributing).

Expand All @@ -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 <em>FMU SDK by Qtronic</em>, 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).

0 comments on commit 20298f1

Please sign in to comment.