OpenModelica User's Guide

Generated on 2026-11-02 at 19:54

Version: v1.28.0-dev.1688+g77cbb695d7 (diff, doc)

• Introduction
  • System Overview
  • Interactive Session with Examples
  • Summary of Commands for the Interactive Session Handler
  • Running the compiler from command line
• Package Management
  • Overview of Basic Modelica Package Management Concepts
  • The Package Manager
  • How the package index works
• OMEdit - OpenModelica Connection Editor
  • Starting OMEdit
  • MainWindow & Browsers
  • Perspectives
  • File Menu
  • Edit Menu
  • View Menu
  • SSP Menu
  • Simulation Menu
  • Data Reconciliation
  • Sensitivity Optimization Menu
  • Debug Menu
  • Tools Menu
  • Help Menu
  • Modeling a Model
  • Simulating a Model
  • Calibrating an SSP Model
  • 2D Plotting
  • Re-simulating a Model
  • 3D Visualization
  • Animation of Realtime FMUs
  • Interactive Simulation
  • How to Create User Defined Shapes - Icons
  • Global head section in documentation
  • Options
  • __OpenModelica_commandLineOptions Annotation
  • __OpenModelica_simulationFlags Annotation
  • Global and Local Flags
  • Debugger
  • Editing Modelica Standard Library
  • Install Library
  • Convert Libraries using Conversion Scripts
  • State Machines
  • Using OMEdit as Text Editor
  • Temporary Directory, Log Files and Working Directory
  • High DPI Settings
• Modelica Language Server
  • The Language Server Protocol
  • Features
  • Clients
  • Reporting Issues
• UML Class and Instance Diagrams
  • Formats
  • Class Diagrams
  • Instance Diagrams
• Property Probes and CodeProber
  • The Probe Tree
  • Properties
  • Using CodeProber
• 2D Plotting
  • Example
  • Plot Command Interface
• OpenModelica Compiler
  • Frontend Modules
  • Backend Modules
  • Code generation
  • Simulation Runtimes
• Solving Modelica Models
  • Integration Methods
  • DAE Mode Simulation
  • Initialization
  • Tearing
  • Algebraic Solvers
• Automatic Parallelization of Simulations
  • Run-time flags
  • JSON format
  • External tools
  • The optimization workflow
• Debugging
  • The Equation-based Debugger
  • The Algorithmic Debugger
• Flattening models to BaseModelica
  • BaseModelica
  • Converting Modelica models in BaseModelica with OpenModelica
  • Array-preserving BaseModelica output
• Acausal DAE Separate Compilation
  • Overview
  • Scripting API
  • Example
  • Code reuse
  • Result file
  • Working directory
  • Limitations
• Porting Modelica libraries to OpenModelica
  • Mapping of the library on the file system
  • Modifiers for arrays
  • Access to conditional components
  • Access to classes defined in partial packages
  • Equality operator in algorithms
  • Public non-input non-output variables in functions
  • Subscripting of expressions
  • Incomplete specification of initial conditions
  • Modelica_LinearSystems2 Library
• Backwards Compatibility of OpenModelica Released Versions
• Generating Graph Representations for Models
• Functional Mock-up Interface - FMI
  • FMI Standards
  • FMI Export
  • FMI Import - SSP
• OMSimulator
  • Introduction
  • OMSimulator
• Running a Python script
• Running an SSP file
• Running an FMU
  • OMSimulatorLib
  • OMSimulatorPython3
  • OpenModelicaScripting
  • OMEdit
  • OMSimulatorGui
• System Identification
  • Examples
  • Python and C API
• OpenModelica Encryption
  • Encrypting the Library
  • Loading an Encrypted Library
  • Notes
• OMNotebook with DrModelica and DrControl
  • Interactive Notebooks with Literate Programming
  • DrModelica Tutoring System - an Application of OMNotebook
  • DrControl Tutorial for Teaching Control Theory
  • OpenModelica Notebook Commands
  • References
• Optimization with OpenModelica
  • Built-in Dynamic Optimization using Annotations
  • Built-in Dynamic Optimization using Optimica language extensions
  • Dynamic Optimization with OpenModelica and CasADi
  • Parameter Sweep Optimization using OMOptim
• Parameter Sensitivities with OpenModelica
  • Single Parameter sensitivities with IDA/Sundials
  • Single and Multi-parameter sensitivities with OMSens
• PDEModelica1
  • PDEModelica1 language elements
  • Limitations
  • Viewing results
• MDT - The OpenModelica Development Tooling Eclipse Plugin
  • Introduction
  • Installation
  • Getting Started
• MDT Debugger for Algorithmic Modelica
  • The Eclipse-based Debugger for Algorithmic Modelica
• Modelica Performance Analyzer
  • Profiling information for ProfilingTest
  • Genenerated JSON for the Example
  • Using the Profiler from OMEdit
• Simulation in Web Browser
• Interoperability - C and Python
  • Calling External C functions
  • Calling external Python Code from a Modelica model
  • Calling OpenModelica from Python Code
• OMPython - OpenModelica Python Interface
  • Features of OMPython
  • Session Classes
  • Modelica System Classes
  • Design of Experiments
  • Execute Compiled Models
  • Parsers - Parsing OMC Return Data
  • Compatibility with OMPython v4.0.0
• OMMatlab - OpenModelica Matlab Interface
  • Features of OMMatlab
  • Test Commands
  • WorkDirectory
  • BuildModel
  • Standard get methods
  • Usage of getMethods
  • Standard set methods
  • Usage of setMethods
  • Advanced Simulation
  • Linearization
  • Usage of Linearization methods
• OMJulia - OpenModelica Julia Scripting
• Jupyter-OpenModelica
• Scripting API
  • OpenModelica Scripting Commands
  • Simulation Parameter Sweep
  • Examples
• OpenModelica Compiler Flags
  • Options
  • Debug flags
  • Flags for Optimization Modules
• Simulation Runtime Flags
  • C Runtime Simulation Flags
• Technical Details
  • The MATv4 Result File Format
  • The Arrow Result File Format
• Data Reconciliation
  • Objective of Data Reconciliation
  • Defining the Data Reconciliation Problem in OpenModelica
  • Data Reconciliation Support in OMEdit
  • Computing the Boundary Conditions from the Reconciled Values
  • Contacts
  • References
• Frequently Asked Questions (FAQ)
  • OpenModelica General
  • OMNotebook

• Major OpenModelica Releases
• Contributors to OpenModelica

Indices and tables

• Index

• Search Page

Copyright

Copyright © 1998-2026 Open Source Modelica Consortium (OSMC)

c/o Linköpings universitet, Department of Computer and Information Science

SE-58183 Linköping, Sweden

This work is licensed under a Creative Commons Attribution 4.0 International License.

This document is part of OpenModelica: https://www.openmodelica.org Contact: OpenModelica@ida.liu.se

Modelica^® is a registered trademark of the Modelica Association, https://www.Modelica.org

Mathematica^® is a registered trademark of Wolfram Research Inc, http://www.wolfram.com

This users guide provides documentation and examples on how to use the OpenModelica system, both for the Modelica beginners and advanced users.