.. _user_guide:

User Guide
==========

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

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Introduction

   installation
   getting_started

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Usage

   fmu_export
   simulation
   rdm