Metadata-Version: 2.1
Name: sofirpy
Version: 1.0.2
Summary: Framework for simulating FMUs and custom models written in python.
Author-email: Daniele Inturri <daniele.inturri@stud.tu-darmstadt.de>
License: MIT License
        
        Copyright (c) 2024 Daniele Inturri
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://git.rwth-aachen.de/sofirpy/sofirpy
Project-URL: documentation, https://sofirpy.readthedocs.io/
Keywords: simulation,fmu
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: FMPy>=0.3.0
Requires-Dist: cloudpickle>=2.2.1
Requires-Dist: tqdm>=4.60.0
Requires-Dist: h5py>=3.0.0
Requires-Dist: matplotlib>=3.2.0
Requires-Dist: numpy>=1.20.0
Requires-Dist: pandas>=1.3.0
Requires-Dist: OMpython>=3.4.0
Requires-Dist: typing_extensions>=4.3.0
Requires-Dist: pydantic>=2.0.0
Provides-Extra: test
Requires-Dist: pytest>=7.1.2; extra == "test"
Requires-Dist: pytest-cov>=3.0.0; extra == "test"
Requires-Dist: mypy>=1.5.1; extra == "test"
Requires-Dist: pandas-stubs>=1.4.3.220822; extra == "test"
Requires-Dist: syrupy>=4.5.0; extra == "test"
Requires-Dist: types-setuptools>=68.2.0.0; extra == "test"
Requires-Dist: types-tqdm>=4.64.5; extra == "test"
Requires-Dist: types-pytz>=2022.2.1.0; extra == "test"
Provides-Extra: dev
Requires-Dist: black>=22.12.0; extra == "dev"
Requires-Dist: isort>=5.12.0; extra == "dev"
Requires-Dist: pylint>=2.15.3; extra == "dev"
Requires-Dist: pre-commit>=3.2.2; extra == "dev"
Requires-Dist: ruff>=0.1.11; extra == "dev"
Provides-Extra: doc
Requires-Dist: sphinx>=5.1.1; extra == "doc"
Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "doc"

 # SOFIRpy
[![Latest Release](https://git.rwth-aachen.de/sofirpy/sofirpy/-/badges/release.svg)]()
[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![pipeline status](https://git.rwth-aachen.de/sofirpy/sofirpy/badges/master/pipeline.svg)](https://git.rwth-aachen.de/sofirpy/sofirpy/-/commits/master)
[![Documentation Status](https://readthedocs.org/projects/sofirpy/badge/?version=latest)](https://sofirpy.readthedocs.io/en/latest/?badge=latest)
[![coverage](https://git.rwth-aachen.de/sofirpy/sofirpy/badges/master/coverage.svg)]()


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

 ## Install
SOFIRpy can be installed from PyPI using the following command.
```console
$ pip install sofirpy
```
## Documentation
The documentation can be found [here](https://sofirpy.readthedocs.io).

## Examples
Multiple examples can be found [here](https://git.rwth-aachen.de/sofirpy/sofirpy/-/tree/master/examples).
