https://github.com/sciml/basemodelica.jl

Importers for the BaseModelica standard into the Julia ModelingToolkit ecosystem
https://github.com/sciml/basemodelica.jl

dae differential-equations julia modelica ode sciml symbolic-numeric-computing

Last synced: 6 months ago
JSON representation

Importers for the BaseModelica standard into the Julia ModelingToolkit ecosystem

• Host: GitHub
• URL: https://github.com/sciml/basemodelica.jl
• Owner: SciML
• License: mit
• Created: 2024-02-23T14:49:51.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-10T21:41:25.000Z (6 months ago)
• Last Synced: 2025-04-10T22:31:42.653Z (6 months ago)
• Topics: dae, differential-equations, julia, modelica, ode, sciml, symbolic-numeric-computing
• Language: Julia
• Homepage: https://docs.sciml.ai/BaseModelica/stable/
• Size: 593 KB
• Stars: 8
• Watchers: 5
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# BaseModelica.jl

[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)

[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/BaseModelica/stable/)

[![codecov](https://codecov.io/gh/SciML/BaseModelica.jl/branch/main/graph/badge.svg)](https://app.codecov.io/gh/SciML/BaseModelica.jl)

[![Build Status](https://github.com/SciML/BaseModelica.jl/workflows/CI/badge.svg)](https://github.com/SciML/BaseModelica.jl/actions?query=workflow%3ACI)

[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)

[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)

A parser for the [Base Modelica](https://github.com/modelica/ModelicaSpecification/tree/MCP/0031/RationaleMCP/0031) format. Contains utilities to parse Base Modelica model files in to Julia objects, and to convert Base Modelica models to [ModelingToolkit](https://docs.sciml.ai/ModelingToolkit/stable/) 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](https://github.com/modelica/ModelicaSpecification/blob/MCP/0031/RationaleMCP/0031/functions.md) 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:

```julia

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")

```