Welcome to SOFIRpy's documentation!
====================================

Co- **S**\imulation **O**\f **F**\unctional Mock-up Units (FMU) with **I**\ntegrated
**R**\esearch Data Management (SOFIRpy) is a python package that lets you
co-simulate FMUs with custom models written in python.

The package provides functionalities to:

- Export Dymola and OpenModelica models as a FMU
- Co-simulate FMUs with custom written models in python
- Store data and meta data of the simulation inside a hdf5 file

Use Cases
---------

**Control of physical systems.**

Tools like OpenModelica and Dymola are excellent tools for modelling complex
physical systems. These models can be exported as FMUs and co-simulated with
custom written controllers in python. Thereby Python offers extensive tools for
the development of control systems, such as machine learning toolboxes, so that
complex control strategies can be implemented.

**Research Data Management (RDM)**

Easy-to-use functionalities for storing and reading simulation data and meta data.


Table of Contents
==================
.. toctree::
   :maxdepth: 1

   installation
   getting_started
   fmu_export
   simulation
   rdm
   release_notes
   API Documentation <API Documentation/sofirpy>
   contribution


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`