Metadata-Version: 2.4
Name: gemseo-fmu
Version: 3.1.1
Summary: GEMSEO plugin for FMU dynamic models.
Author-email: GEMSEO team <contact@gemseo.org>
License-Expression: LGPL-3.0
Project-URL: Homepage, https://gemseo.org
Project-URL: Source, https://gitlab.com/gemseo/dev/gemseo-fmu
Project-URL: Issues, https://gitlab.com/gemseo/dev/gemseo-fmu/-/issues
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: <3.14,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: delta==0.4.2
Requires-Dist: fmpy<=0.3.19,>=0.3.13
Requires-Dist: gemseo[all]<7,>=6.3
Requires-Dist: numpy
Dynamic: license-file

<!--
Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
International License. To view a copy of this license, visit
http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative
Commons, PO Box 1866, Mountain View, CA 94042, USA.
-->

# gemseo-fmu

[![PyPI - License](https://img.shields.io/pypi/l/gemseo-fmu)](https://www.gnu.org/licenses/lgpl-3.0.en.html)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/gemseo-fmu)](https://pypi.org/project/gemseo-fmu/)
[![PyPI](https://img.shields.io/pypi/v/gemseo-fmu)](https://pypi.org/project/gemseo-fmu/)
[![Codecov branch](https://img.shields.io/codecov/c/gitlab/gemseo:dev/gemseo-fmu/develop)](https://app.codecov.io/gl/gemseo:dev/gemseo-fmu)

## Overview

GEMSEO-FMU is a [GEMSEO](https://gemseo.readthedocs.io) plugin for
loading, interacting, and simulating Functional Mockup Unit models
(FMUs). FMUs are widely used by the simulation community and can be
generated by over 200 tools such as Dymola, OpenModelica, CATIA, ANSYS,
LS-DYNA, or MATLAB (see the full list here
<https://www.fmi-standard.org/tools>).

GEMSEO-FMU enables the integration and exploitation of FMUs in a
Multidisciplinary Design Optimization (MDO) context, via GEMSEO. For
that, it wraps the FMU model into a GEMSEO discipline named
`FMUDiscipline`.
GEMSEO-FMU also offers a `TimeSteppingSystem` class
to co-simulate FMU models using a master algorithm.

GEMSEO-FMU relies on the [FMPy](https://github.com/CATIA-Systems/FMPy)
library for loading the FMU models, setting the model parameters and
evaluating model equations. Model Exchange and Co-Simulation types as
well as versions 1.0, 2.0 and 3.0 of the FMI standard are supported by
FMPy, and so by GEMSEO-FMU.

## Installation

Install the latest version with `pip install gemseo-fmu`.

See [pip](https://pip.pypa.io/en/stable/getting-started/) for more information.

## Bugs and questions

Please use the [gitlab issue tracker](https://gitlab.com/gemseo/dev/gemseo-fmu/-/issues)
to submit bugs or questions.

## Contributing

See the [contributing section of GEMSEO](https://gemseo.readthedocs.io/en/stable/software/developing.html#dev).

## Contributors

- Jorge Camacho Casero
- François Gallard
- Antoine Dechaume
- Matthias De Lozzo
