User Guide¶
This section provides in-depth documentation for every feature of FMU Manipulation Toolbox. Whether you prefer a graphical interface, the command line, or a Python script, you'll find guidance here.
Features at a Glance¶
FMU Manipulation Toolbox offers five main capabilities:
-
Analysis
Inspect FMU contents, list ports, validate against XSD schemas, and run compliance checks.
-
Modification
Rename ports, filter variables, strip hierarchy levels, and batch-edit attributes — all without recompilation.
-
FMU Containers
Combine multiple FMUs into a single container with automatic or explicit routing, multi-threading, and profiling.
-
Remoting
Add cross-bitness interfaces (32 ↔ 64-bit) or run an FMU in a separate process via a frontend wrapper.
-
Checker
Validate FMUs against built-in rules or your own custom checkers.
Available Interfaces¶
All features are accessible through the Command Line Interface and the Python API. The Graphical User Interface supports a subset of operations, as summarized below:
| Feature | CLI | Python API | GUI |
|---|---|---|---|
| Analysis | |||
| Modification | |||
| FMU Variable Editor | — | — | |
| FMU Containers | |||
| Remoting | |||
| Checker |
Which interface should I use?
- GUI — Best for interactive exploration: loading an FMU, visually inspecting its ports, applying quick modifications, editing variables, or building FMU containers with a node-graph editor. The Launcher gives you quick access to all GUI tools.
- CLI — Ideal for automation, scripting, and CI/CD pipelines. Every feature is available from the command line.
- Python API — Offers full programmatic control for complex workflows, batch processing, and custom integrations.
Guides by Topic¶
Launcher¶
| Guide | Description |
|---|---|
| FMU Toolbox Launcher | Unified entry point for all GUI tools (fmutoolbox) |
Understand & Modify FMUs¶
| Guide | Description |
|---|---|
| CLI Usage | Complete reference for all fmutool command-line options |
| Operations GUI | Step-by-step guide to the graphical interface (fmutool-gui) |
| Variable Editor | Spreadsheet-like editor for variable names, descriptions, and experiment settings (fmueditor) |
| Python API | Programmatic access to analysis and modification operations |
| Remoting | Add cross-bitness or frontend interfaces to your FMUs |
| Checker | Built-in and custom FMU validation rules |
FMU Container¶
| Guide | Description |
|---|---|
| Container Concept | How to combine multiple FMUs into a single container |
| Container Builder | Visual node-graph editor to build containers (fmucontainer-gui) |
| Variable Step Size | Handling variable step sizes inside containers |
| Datalog | Logging simulation data from containers |
| LS-BUS Support | Network bus signal routing in containers |