Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/LBNL-ETA/SimulatorToFMU

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/LBNL-ETA/SimulatorToFMU
Owner: LBNL-ETA
Created: 2017-04-21T23:52:21.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2022-12-23T12:28:36.000Z (almost 2 years ago)
Last Synced: 2024-07-22T17:59:24.733Z (4 months ago)
Language: Python
Size: 173 MB
Stars: 41
Watchers: 10
Forks: 10
Open Issues: 14
Metadata Files:
- Readme: README.rst

Awesome Lists containing this project

awesome-fmi - SimulatorToFMU - Python package that allows to export a memoryless Python-driven simulation program or script as a FMU. [BSD] (FMI 2 / Libraries)

README

        SimulatorToFMU

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

|SimulatorToFMU Tests|

.. |SimulatorToFMU Tests| image:: https://github.com/LBNL-ETA/SimulatorToFMU/actions/workflows/unitTest.yml/badge.svg

   :target: https://github.com/LBNL-ETA/SimulatorToFMU/actions/workflows/unitTest.yml

Overview

^^^^^^^^

SimulatorToFMU is a software package written in Python which allows 

users to export a Python-driven simulation program or a Python script 

as a Functional Mock-up Unit (FMU) for  

model-exchange or co-simulation using the Functional Mock-up Interface (FMI) 

standard version 1.0 or 2.0 (https://www.fmi-standard.org).

This FMU can then be imported into a variety of simulation programs 

that support the import of Functional Mock-up Units.

.. note::

  SimulatorToFMU generates FMUs that use the Python/C API for interfacing 

  with Python-driven simulation programs and Python scripts.

Requirements

^^^^^^^^^^^^

- `jinja2 `_

- `lxml `_

Installation

^^^^^^^^^^^^

To install SimulatorToFMU, clone the master branch of the development repository locally or run

.. code:: text

   pip install --user git+https://github.com/LBNL-ETA/SimulatorToFMU.git

For more information visit the development page at `https://github.com/LBNL-ETA/SimulatorToFMU `_

The license is at `LICENSE.txt `_

Help

^^^^

- For support questions use the `SimulatorToFMU Forum `_

- For bug reports use the `SimulatorToFMU GitHub Issues `_