mdreader 0.1.0

A Python library for reading and parsing Functional Mock-up Interface model description XML file.

mdreader

A Python library for reading and parsing Functional Mock-up Interface (FMI2.0 currently) model description XML file.

Pydantic models are used to represent the structure of the model description, providing type validation and easy access to model information.

Installation

It is suggested to add mdreader to your pyproject.toml with uv by running:

uv add mdreader

To install uv, see https://docs.astral.sh/uv/getting-started/installation/

Other installation options

Option 1: Add mdreader to an existing virtual environment with uv

uv pip install mdreader

Option 2: Add mdreader with pip

pip install -U mdreader

Getting started

from mdreader.fmi2 import read_model_description

# Read from XML file
md = read_model_description("path/to/modelDescription.xml")

# Read from FMU file
md = read_model_description("path/to/model.fmu")

# Read from an unzipped fmu directory containing modelDescription.xml
md = read_model_description("path/to/directory")

Features

• Parse FMI 2.0 model description XML files
• Read model information from FMU archives
• Access model metadata (name, version, author, GUID, etc.)
• Extract variable definitions (real, integer, boolean, string, enumeration)
• Access unit definitions and type definitions
• Support for both Model Exchange and Co-Simulation interfaces
• Parse model structure, dependencies, and experiment configurations

Related projects

• fmpy

Why another FMI model description reader?

• Lightweight: mdreader only depends on Pydantic
• De/Serialization: Pydantic models support easy serialization to/from JSON, dict, etc.
• Validation: mdreader uses Pydantic models to ensure the integrity of the parsed data
• FMI version exclusive: The fmi2.FMIModelDescription class is specific to FMI 2.0 (not a mix of FMI1/2/3), making it simpler to use for that version

Licensing

The code in this project is licensed under MIT license. See the LICENSE file for details.