Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/CATIA-Systems/FMPy

Simulate Functional Mockup Units (FMUs) in Python
https://github.com/CATIA-Systems/FMPy

fmi fmi-standard python

Last synced: 3 months ago
JSON representation

Simulate Functional Mockup Units (FMUs) in Python

Host: GitHub
URL: https://github.com/CATIA-Systems/FMPy
Owner: CATIA-Systems
License: other
Created: 2017-05-17T12:59:50.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2024-06-14T06:36:41.000Z (5 months ago)
Last Synced: 2024-07-18T21:44:13.127Z (4 months ago)
Topics: fmi, fmi-standard, python
Language: Python
Homepage:
Size: 15.1 MB
Stars: 412
Watchers: 27
Forks: 117
Open Issues: 101
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE.txt

Awesome Lists containing this project

awesome-modelica - FMPy Github
awesome-robotic-tooling - FMPy - Simulate Functional Mockup Units (FMUs) in Python. (Electronics and Mechanics / Version Control)
awesome-fmi - FMPy - Python package for loading and interacting with FMUs. It supports also the latest [System Structure and Parameterization (SSP standard)](https://www.modelica.org/projects). [BSD] (FMI 2 / Libraries)

README

        [![Build Status](https://dev.azure.com/CATIA-Systems/FMPy/_apis/build/status/CATIA-Systems.FMPy?branchName=develop)](https://dev.azure.com/CATIA-Systems/FMPy/_build/latest?definitionId=1&branchName=develop)

[![PyPI](https://img.shields.io/pypi/dm/FMPy.svg?label=PyPI%20downloads)](https://pypi.org/project/FMPy/)

[![Conda](https://img.shields.io/conda/dn/conda-forge/FMPy.svg?label=Conda%20downloads)](https://anaconda.org/conda-forge/fmpy)

[![Read the Docs](https://readthedocs.org/projects/fmpy/badge/?version=latest)](https://fmpy.readthedocs.io/)

# FMPy

FMPy is a free Python library to simulate [Functional Mock-up Units (FMUs)](http://fmi-standard.org/) that...

- supports FMI 1.0, 2.0, and 3.0

- supports Co-Simulation and Model Exchange

- runs on Windows, Linux and macOS

- has a [command line](#simulate-an-fmu-on-the-command-line), [graphical user interface](#start-the-graphical-user-interface), and [web app](#start-the-web-app)

- creates [Jupyter Notebooks](#create-a-jupyter-notebook)

- compiles C code FMUs and generates [CMake](https://cmake.org/) projects for debugging

## Installation

Several options are available:

- Install with conda: `conda install -c conda-forge fmpy`

- Install with from PyPI: `python -m pip install fmpy[complete]`

- [Install a development build](docs/faq.md)

If you don't have Python on your machine you can install [Miniforge](https://github.com/conda-forge/miniforge).

## Start the Graphical User Interface

You can start the FMPy GUI with `python -m fmpy.gui`

![FMPy GUI](docs/Rectifier_GUI.png)

## Simulate an FMU in Python

To follow this example download `Rectifier.fmu` for your platform by clicking on the respective link:

[Linux](https://github.com/modelica/fmi-cross-check/raw/master/fmus/2.0/cs/linux64/MapleSim/2018/Rectifier/Rectifier.fmu),

[macOS](https://github.com/modelica/fmi-cross-check/raw/master/fmus/2.0/cs/darwin64/MapleSim/2018/Rectifier/Rectifier.fmu),

[Windows](https://github.com/modelica/fmi-cross-check/raw/master/fmus/2.0/cs/win64/MapleSim/2018/Rectifier/Rectifier.fmu).

Change to the folder where you've saved the FMU and open a Python prompt.

```

>>> from fmpy import *

>>> fmu = 'Rectifier.fmu'

>>> dump(fmu)  # get information

Model Info

  FMI Version       2.0

  Model Name        Rectifier

  Description       Model Rectifier

  Platforms         win64

  Continuous States 4

  Event Indicators  6

  Variables         63

  Generation Tool   MapleSim (1267140/1267140/1267140)

  Generation Date   2017-10-04T12:07:10Z

Default Experiment

  Stop Time         0.1

  Step Size         1e-07

Variables (input, output)

Name                Causality          Start Value  Unit     Description

outputs             output        282.842712474619  V        Rectifier1.Capacitor1.v

>>> result = simulate_fmu(fmu)         # simulate the FMU

>>> from fmpy.util import plot_result  # import the plot function

>>> plot_result(result)                # plot two variables

```

![Rectifier Result](docs/Rectifier_result.png)

## Simulate an FMU on the command line

To get information about an FMU directly from the command line change to the folder where you've saved the

FMU and enter

```

fmpy info Rectifier.fmu

```

Simulate the FMU and plot the results

```

fmpy simulate Rectifier.fmu --show-plot

```

Get more information about the available options

```

fmpy --help

```

## Create a Jupyter Notebook

To create a [Jupyter](https://jupyter.org/) Notebook open an FMU in the FMPy GUI and select `Tools > Create Jupyter Notebook...` or run

```

fmpy create-jupyter-notebook Rectifier.fmu

```

on the command line and open the notebook in Jupyter with

```

jupyter notebook Rectifier.ipynb

```

![Web App](docs/Rectifier_Notebook.png)

## Start the Web App

The FMPy Web App is built with [Dash](https://plotly.com/dash/) and a great way to share your FMUs with anyone that has a web browser.

To start it run

```

python -m fmpy.webapp Rectifier.fmu

```

on the command line or use `--help` for more options.

![Web App](docs/Rectifier_WebApp.png)

## Advanced Usage

To learn more about how to use FMPy in you own scripts take a look at the

[coupled_clutches.py](fmpy/examples/coupled_clutches.py),

[custom_input.py](fmpy/examples/custom_input.py) and

[parameter_variation.py](fmpy/examples/parameter_variation.py) examples.

## Commercial Support

You're starting a project, need training or professional support?

Our partners at LTX Simulation are ready to help you.

Please send an e-mail to [email protected] for a quote.

------------------------------------

© 2023 Dassault Systèmes