Skip to content

Command-Line Help for fmusim

This document contains the help content for the fmusim command-line program.

fmusim

Work with Functional Mock-up Units

Usage: fmusim <COMMAND>

Subcommands:
  • info — Display information about an FMU
  • list — List the files contained in an FMU archive
  • simulate — Simulate an FMU
  • generate-config — Generate a simulation configuration file from an FMU
  • validate — Validate an FMU
  • build — Build the platform binary for an FMU with CMake

fmusim info

Display information about an FMU

Usage: fmusim info <FMU_FILE>

Arguments:
  • <FMU_FILE> — Path to the FMU file

fmusim list

List the files contained in an FMU archive

Usage: fmusim list <FMU_FILE>

Arguments:
  • <FMU_FILE> — Path to the FMU file

fmusim simulate

Simulate an FMU

Usage: fmusim simulate [OPTIONS] <FMU_FILE>

Arguments:
  • <FMU_FILE> — Path to the FMU file
Options:
  • --log-fmi-calls — Enable logging of FMI function calls
  • --log-file <LOG_FILE> — File to write the log to (default: stderr)
  • --output-interval <OUTPUT_INTERVAL> — Interval for sampling the output variables
  • --log-time-scale — Use logarithmic time scale
  • --start-time <START_TIME> — Start time for the simulation
  • --stop-time <STOP_TIME> — Stop time for the simulation
  • --set-stop-time — Set stop time explicitly
  • --tolerance <TOLERANCE> — Relative tolerance for the simulation
  • --set-tolerance — Set tolerance explicitly
  • --input-file <INPUT_FILE> — CSV file to read the input from
  • --output-file <OUTPUT_FILE> — CSV file to store the output
  • --intermediate-update — Set inputs and get outputs in intermediate update mode
  • --show-plot — Plot of up to 8 output variables
  • --plot-file <PLOT_FILE> — HTML file to write the plot to
  • --reference-file <REFERENCE_FILE> — CSV file to read the reference output from
  • --start-value <START_VALUES> — Set start values for variables (format: variable_name=value)
  • --output-variable <OUTPUT_VARIABLES> — Record a specific variable
  • --early-return-allowed — Allow early return
  • --event-mode-used — Use event mode
  • --visible — FMU is executed in interactive mode
  • --logging-on — Enable FMU looging
  • --show-stats — Show statisics
  • --interface-type <INTERFACE_TYPE> — The interface type to use

Possible values: - me: Model Exchange - cs: Co-Simulation

  • --fixed-step-size <FIXED_STEP_SIZE> — Step size for fixed step solver (default: output interval)
  • --solver <SOLVER> — The solver to integrate Model Exchange FMUs

Default value: cvode

Possible values: euler, cvode, ida

  • --enable-dae — Enable DAE mode
  • --initial-fmu-state-file <INITIAL_FMU_STATE_FILE> — File to read the serialized FMU state from
  • --final-fmu-state-file <FINAL_FMU_STATE_FILE> — File to write the serialized FMU state to
  • --library-kind <LIBRARY_KIND> — The library kind to use

Possible values: native, wasm32

fmusim generate-config

Generate a simulation configuration file from an FMU

Usage: fmusim generate-config [OPTIONS] <FMU_FILE>

Arguments:
  • <FMU_FILE> — Path to the FMU file
Options:
  • --config-file <CONFIG_FILE> — Path to write the configuration file (default: stdout)

fmusim validate

Validate an FMU

Usage: fmusim validate <FMU_FILE>

Arguments:
  • <FMU_FILE> — Path to the FMU file

fmusim build

Build the platform binary for an FMU with CMake

Usage: fmusim build [OPTIONS] <FMU_FILE>

Arguments:
  • <FMU_FILE> — Path to the FMU file
Options:
  • --project-path <PROJECT_PATH> — Path to the generated CMake project directory (default: temporary directory)
  • --cmake-generator <CMAKE_GENERATOR> — CMake generator to use (default: platform default)
  • --cmake-architecture <CMAKE_ARCHITECTURE> — CMake architecture to use (default: platform default)
  • --cmake-options <CMAKE_OPTIONS> — Additional CMake options to pass to the build system
  • --debug — Create a debug build (default: release build)