BaseModelica.jl

Importers for the BaseModelica standard into the Julia ModelingToolkit ecosystem
Author SciML
Popularity
5 Stars
Updated Last
24 Days Ago
Started In
February 2024

BaseModelica.jl

Join the chat at https://julialang.zulipchat.com #sciml-bridged Global Docs

codecov Build Status

ColPrac: Contributor's Guide on Collaborative Practices for Community Packages SciML Code Style

A parser for the Base Modelica format. Contains utilities to parse Base Modelica model files in to Julia objects, and to convert Base Modelica models to ModelingToolkit models.

Base Modelica is as of yet only a proposal with no concrete specification, so the grammar and features of the language are subject to change. There is no support for Records, custom types, or custom functions. Any built in BaseModelica functions are not yet supported. Array variables and accessing elements of an array are not yet supported. Only models with real scalar parameters, real scalar variables, and equations consisting of simple arithmetic equations and first order derivatives are able to be translated to an MTK model at this time.

Installation

Assuming that you already have Julia correctly installed, it suffices to import BaseModelica.jl in the standard way:

import Pkg;
Pkg.add("BaseModelica");

Example

A Base Modelica model is in the file ExampleFirstOrder.mo. Inside of the file is a Base Modelica model specifying a simple first order linear differential equation:

package 'FirstOrder'
  model 'FirstOrder'
    parameter Real 'x0' = 0 "Initial value for 'x'";
    Real 'x' "Real variable called 'x'";
  initial equation
    'x' = 'x0' "Set initial value of 'x' to 'x0'";
  equation
    der('x') = 1.0 - 'x'; 
  end 'FirstOrder';
end 'FirstOrder';

To parse the model in the file to ModelingToolkit, use the parse_basemodelica function:

using BaseModelica

parse_basemodelica("path/to/ExampleFirstOrder.mo")

Used By Packages

No packages found.