BaseModelica.jl: BaseModelica Importers for ModelingToolkit.jl

BaseModelica.jl is an interface for the SciML open source software organization for importing BaseModelica, a new standard from the Modelica association for lowered Modelica code. As such, it makes it easy to import Modelica models into ModelingToolkit.

Installation

To install BaseModelica.jl, use the Julia package manager:

using Pkg
Pkg.add("BaseModelica")

API

BaseModelica.parse_basemodelica — Function

parse_basemodelica(filename::AbstractString; parser::Symbol = :antlr)

Parse a BaseModelica source file into a compiled ModelingToolkit system.

Arguments

filename::AbstractString: Path to a BaseModelica source file.

Keyword Arguments

parser::Symbol = :antlr: Parsing backend. :antlr uses the bundled ANTLR grammar; :julia uses the ParserCombinator implementation.

Returns

A compiled ModelingToolkitBase.System representing the equations, variables, parameters, and events in filename.

Errors

Throws an error when parser is neither :antlr nor :julia, or when the selected parser cannot parse filename.

Examples

using BaseModelica

filename = joinpath(pkgdir(BaseModelica), "test", "testfiles", "NewtonCoolingBase.bmo")
system = parse_basemodelica(filename)
@assert !isnothing(system)

source

BaseModelica.parse_experiment_annotation — Function

parse_experiment_annotation(annotation::Union{BaseModelicaAnnotation, Nothing})

Extract simulation settings from a parsed BaseModelica experiment annotation.

This is a developer-level API for code that already owns a BaseModelica AST. It does not parse BaseModelica text and the AST representation is not a supported extension interface for ordinary package users. Use create_odeproblem to apply experiment settings while importing a model.

Arguments

annotation::Union{BaseModelicaAnnotation, Nothing}: A parsed AST annotation. Pass nothing when the imported model has no annotation.

Returns

nothing when no experiment annotation is present or the annotation has no experiment block.
A named tuple with StartTime, StopTime, Tolerance, and Interval otherwise. Missing fields use the Modelica defaults 0.0, 1.0, and 1e-4; Interval remains nothing when unspecified.

Examples

using BaseModelica

parse_experiment_annotation(nothing)
# output
nothing

source

BaseModelica.create_odeproblem — Function

create_odeproblem(filename::AbstractString; parser::Symbol = :antlr, u0 = [], kwargs...)

Parse a BaseModelica source file and create an ODE problem with experiment settings.

If the model has an annotation(experiment(...)) block, its StartTime and StopTime become the problem time span, Tolerance becomes reltol, and Interval becomes saveat. Explicit keyword arguments override those annotation-derived defaults.

Arguments

filename::AbstractString: Path to a BaseModelica source file.
u0: Initial conditions forwarded to SciMLBase.ODEProblem.

Keyword Arguments

parser::Symbol = :antlr: Parsing backend, either :antlr or :julia.
kwargs...: Keyword arguments forwarded to SciMLBase.ODEProblem. reltol and saveat override values read from an experiment annotation.

Returns

A SciMLBase.ODEProblem constructed from the imported ModelingToolkit system.

Errors

Throws an error when the parser cannot read filename or an unsupported parser is requested.

Examples

using BaseModelica

filename = joinpath(pkgdir(BaseModelica), "test", "testfiles", "Experiment.bmo")
prob = create_odeproblem(filename)
prob.tspan
# output
(0.0, 2.0)

source

Contributing

Please refer to the SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages for guidance on PRs, issues, and other matters relating to contributing to SciML.
See the SciML Style Guide for common coding practices and other style decisions.
There are a few community forums:
- The #diffeq-bridged and #sciml-bridged channels in the Julia Slack
- The #diffeq-bridged and #sciml-bridged channels in the Julia Zulip
- On the Julia Discourse forums
- See also SciML Community page

Reproducibility

The documentation of this SciML package was built using these direct dependencies,

Status `~/_work/BaseModelica.jl/BaseModelica.jl/docs/Project.toml`
  [a17d5099] BaseModelica v1.10.1 `~/_work/BaseModelica.jl/BaseModelica.jl`
  [e30172f5] Documenter v1.19.0

and using this machine and Julia version.

Julia Version 1.13.2
Commit 45b6d15e34b (2026-10-14 20:33 UTC)
Build Info:
  Official https://julialang.org release
Platform Info:
  OS: Linux (x86_64-linux-gnu)
  CPU: 128 × AMD EPYC 9354 32-Core Processor
  WORD_SIZE: 64
  LLVM: libLLVM-20.1.8 (ORCJIT, znver4)
  GC: Built with stock GC
Threads: 1 default, 1 interactive, 1 GC (on 4 virtual cores)
Environment:
  JULIA_CPU_THREADS = 4
  JULIA_NUM_PRECOMPILE_TASKS = 4
  JULIA_PYTHONCALL_EXE = /home/runner/_work/BaseModelica.jl/BaseModelica.jl/docs/.CondaPkg/.pixi/envs/default/bin/python

A more complete overview of all dependencies and their versions is also provided.

Status `~/_work/BaseModelica.jl/BaseModelica.jl/docs/Manifest.toml`
  [47edcb42] ADTypes v1.24.0
  [14f7f29c] AMD v0.5.4
  [a4c015fc] ANSIColoredPrinters v0.0.1
  [6e696c72] AbstractPlutoDingetjes v1.4.1
  [1520ce14] AbstractTrees v0.4.5
  [7d9f7c33] Accessors v0.1.45
  [79e6a3ab] Adapt v4.7.4
  [ec485272] ArnoldiMethod v0.4.0
  [4fba245c] ArrayInterface v7.30.2
  [4c555306] ArrayLayouts v1.15.1
  [15f4f7f2] AutoHashEquals v2.2.0
  [aae01518] BandedMatrices v1.14.0
  [a17d5099] BaseModelica v1.10.1 `~/_work/BaseModelica.jl/BaseModelica.jl`
  [e2ed5e7c] Bijections v0.2.2
  [b2a6c25c] BinaryHeaps v1.1.0
  [caf10ac8] BipartiteGraphs v0.1.14
  [8e7c35d0] BlockArrays v1.10.2
  [70df07ce] BracketingNonlinearSolve v1.12.8
  [944b1d66] CodecZlib v0.7.9
⌅ [861a8166] Combinatorics v1.0.2
  [38540f10] CommonSolve v0.2.14
  [bbf7d656] CommonSubexpressions v0.3.1
  [f70d9fcc] CommonWorldInvalidations v1.2.2
  [34da2185] Compat v4.18.1
  [b152e2b5] CompositeTypes v0.1.4
  [a33af91c] CompositionsBase v0.1.2
  [2569d6c7] ConcreteStructs v0.2.8
  [992eb4ea] CondaPkg v0.2.38
  [187b0558] ConstructionBase v1.6.0
  [a8cc5b0e] Crayons v4.2.0
  [9a962f9c] DataAPI v1.16.0
  [864edb3b] DataStructures v0.19.6
  [e2d170a0] DataValueInterfaces v1.0.0
  [8bb1440f] DelimitedFiles v1.9.1
  [2b5f629d] DiffEqBase v7.21.4
  [459566f4] DiffEqCallbacks v4.19.5
  [163ba53b] DiffResults v1.1.0
  [b552c78f] DiffRules v1.16.0
  [a0c0ee7d] DifferentiationInterface v0.7.21
⌅ [ffbed154] DocStringExtensions v0.9.5
  [e30172f5] Documenter v1.19.0
  [5b8099bc] DomainSets v0.8.3
  [7c1d4256] DynamicPolynomials v0.6.8
  [4e289a0a] EnumX v1.0.7
  [f151be2c] EnzymeCore v0.8.23
  [e2ba6199] ExprTools v0.1.11
  [55351af7] ExproniconLite v0.10.14
  [7034ab61] FastBroadcast v1.4.0
  [9aa1b823] FastClosures v0.3.2
  [a4df4552] FastPower v1.5.1
  [1a297f60] FillArrays v1.18.1
  [64ca27bc] FindFirstFunctions v3.4.1
  [6a86dc24] FiniteDiff v2.33.0
  [f6369f11] ForwardDiff v1.4.6
  [a85aefff] FunctionMaps v0.1.2
  [069b7b12] FunctionWrappers v1.1.3
  [77dc65aa] FunctionWrappersWrappers v1.13.0
  [46192b85] GPUArraysCore v0.2.1
  [d7ba0133] Git v1.5.0
  [86223c79] Graphs v1.15.0
  [b5f81e59] IOCapture v1.0.0
  [3263718b] ImplicitDiscreteSolve v2.3.0
  [d25df0c9] Inflate v0.1.5
  [18e54dd8] IntegerMathUtils v0.1.4
  [8197267c] IntervalSets v0.7.15
  [3587e190] InverseFunctions v0.1.17
  [92d709cd] IrrationalConstants v0.2.6
  [82899510] IteratorInterfaceExtensions v1.0.0
  [692b3bcd] JLLWrappers v1.8.0
  [682c06a0] JSON v1.11.0
  [ae98c720] Jieko v0.2.1
⌅ [ccbc3e58] JumpProcesses v9.33.1
  [ba0b0d4f] Krylov v0.10.11
  [2faa5264] LHLFactorization v2.2.2
  [b964fa9f] LaTeXStrings v1.4.1
  [0e77f7df] LazilyInitializedFields v1.3.0
  [87fe0de2] LineSearch v0.1.19
  [7ed4a6bd] LinearSolve v5.18.2
  [2ab3a3ac] LogExpFunctions v1.0.3
  [e6f89c97] LoggingExtras v1.2.0
  [d8e11817] MLStyle v0.4.17
  [1914dd2f] MacroTools v0.5.16
  [d0879d2d] MarkdownAST v0.1.3
  [bb5d69b7] MaybeInplace v0.1.8
  [0b3b1443] MicroMamba v0.1.15
  [961ee093] ModelingToolkit v11.45.4
  [7771a370] ModelingToolkitBase v1.77.4
  [6bb917b9] ModelingToolkitTearing v1.20.7
  [2e0e35c7] Moshi v0.3.13
  [46d2c3a1] MuladdMacro v0.2.7
  [102ac46a] MultivariatePolynomials v0.5.20
  [d8a4904e] MutableArithmetics v1.9.0
  [77ba4419] NaNMath v1.1.4
  [be0214bd] NonlinearSolveBase v2.55.0
  [5959db7a] NonlinearSolveFirstOrder v2.10.0
  [6fe1bfb0] OffsetArrays v1.17.0
  [bac558e1] OrderedCollections v2.0.3
  [bbf590c4] OrdinaryDiffEqCore v4.19.0
  [fae87a5f] ParserCombinator v2.2.1
  [69de0a69] Parsers v3.0.0
  [e409e4f3] PoissonRandom v0.4.14
  [d236fae5] PreallocationTools v1.7.1
  [aea7be01] PrecompileTools v1.3.4
  [21216c6a] Preferences v1.6.0
  [08abe8d2] PrettyTables v3.5.0
  [27ebfcd6] Primes v0.5.7
  [0c0d3e7f] PureKLU v1.6.0
  [6099a3de] PythonCall v0.9.37
  [988b38a3] ReadOnlyArrays v0.2.0
  [795d4caa] ReadOnlyDicts v1.0.1
  [3cdcf5f2] RecipesBase v1.4.0
  [731186ca] RecursiveArrayTools v4.5.5
  [189a3867] Reexport v1.2.2
  [2792f1a3] RegistryInstances v0.1.0
  [9fe22ead] RespecializeParams v1.3.0
  [7e49a35a] RuntimeGeneratedFunctions v0.5.27
  [9dfe8606] SCCNonlinearSolve v1.16.0
  [0bca4576] SciMLBase v3.58.0
  [19f34311] SciMLJacobianOperators v0.1.20
  [a6db7da4] SciMLLogging v2.1.0
  [c0aeaf25] SciMLOperators v1.30.3
  [431bcebd] SciMLPublic v1.3.0
  [53ae85a6] SciMLStructures v1.10.6
  [6c6a2e73] Scratch v1.3.0
  [efcf1570] Setfield v1.1.2
  [727e6d20] SimpleNonlinearSolve v2.14.6
  [699a6c99] SimpleTraits v0.9.6
  [ed01d8cd] Sobol v1.5.0
  [a57abbd0] SparseColumnPivotedQR v2.1.8
  [276daf66] SpecialFunctions v2.9.0
  [0c0c59c1] StarAlgebras v0.3.0
  [64909d44] StateSelection v1.11.1
  [90137ffa] StaticArrays v1.9.23
  [1e83bf80] StaticArraysCore v1.4.4
  [10745b16] Statistics v1.11.5
  [892a3eda] StringManipulation v0.6.1
  [ec057cc2] StructUtils v2.10.0
  [2efcf032] SymbolicIndexingInterface v0.3.55
  [19f23fe9] SymbolicLimits v1.2.2
  [d1185830] SymbolicUtils v4.51.0
  [0c5d862f] Symbolics v7.46.0
  [3783bdb8] TableTraits v1.0.1
  [bd369af6] Tables v1.14.0
  [ed4db957] TaskLocalValues v0.1.3
  [8ea1fca8] TermInterface v2.0.1
  [a759f4b9] TimerOutputs v1.2.2
  [3bb67fe8] TranscodingStreams v0.11.3
  [781d530d] TruncatedStacktraces v1.4.0
  [3a884ed6] UnPack v1.0.2
  [e17b2a0c] UnsafePointers v1.0.0
  [d30d5f5c] WeakCacheSets v0.1.0
  [2e619515] Expat_jll v2.8.4+0
  [020c3dae] Git_LFS_jll v3.7.1+0
  [f8c6e375] Git_jll v2.56.0+0
  [1d5cc7b8] IntelOpenMP_jll v2025.2.0+0
  [94ce4f54] Libiconv_jll v1.18.0+0
  [856f044c] MKL_jll v2025.2.0+0
  [9bd350c2] OpenSSH_jll v10.6.1+0
  [efe28fd5] OpenSpecFun_jll v0.5.6+0
  [f8abcde7] micromamba_jll v2.3.1+0
  [1317d2d5] oneTBB_jll v2023.1.0+0
  [4d7b5844] pixi_jll v0.76.2+0
  [0dad84c5] ArgTools v1.1.2
  [56f22d72] Artifacts v1.11.0
  [2a0f44e3] Base64 v1.11.0
  [ade2ca70] Dates v1.11.0
  [8ba89e20] Distributed v1.11.0
  [f43a241f] Downloads v1.7.0
  [7b1f6079] FileWatching v1.11.0
  [9fa8497b] Future v1.11.0
  [b77e0a4c] InteractiveUtils v1.11.0
  [ac6e5ff7] JuliaSyntaxHighlighting v1.12.0
  [4af54fe1] LazyArtifacts v1.11.0
  [b27032c2] LibCURL v1.0.0
  [76f85450] LibGit2 v1.11.0
  [8f399da3] Libdl v1.11.0
  [37e2e46d] LinearAlgebra v1.13.0
  [56ddb016] Logging v1.11.0
  [d6f4376e] Markdown v1.11.0
  [a63ad114] Mmap v1.11.0
  [ca575930] NetworkOptions v1.3.0
  [44cfe95a] Pkg v1.13.0
  [de0858da] Printf v1.11.0
  [3fa0cd96] REPL v1.11.0
  [9a3f8284] Random v1.11.0
  [ea8e919c] SHA v1.0.0
  [9e88b42a] Serialization v1.11.0
  [6462fe0b] Sockets v1.11.0
  [2f01184e] SparseArrays v1.13.0
  [f489334b] StyledStrings v1.11.0
  [fa267f1f] TOML v1.0.3
  [a4e569a6] Tar v1.10.0
  [8dfed614] Test v1.11.0
  [cf7118a7] UUIDs v1.11.0
  [4ec0a83e] Unicode v1.11.0
  [e66e0078] CompilerSupportLibraries_jll v1.5.5+2
  [deac9b47] LibCURL_jll v8.22.0+0
  [e37daf67] LibGit2_jll v1.9.7+0
  [29816b5a] LibSSH2_jll v1.11.104+0
  [14a3606d] MozillaCACerts_jll v2026.8.13
  [4536629a] OpenBLAS_jll v0.3.30+0
  [05823500] OpenLibm_jll v0.8.7+0
  [458c3c95] OpenSSL_jll v3.5.8+0
  [efcefdf7] PCRE2_jll v10.46.0+0
  [bea87d4a] SuiteSparse_jll v7.10.1+0
  [83775a58] Zlib_jll v1.3.2+0
  [3161d3a3] Zstd_jll v1.5.7+1
  [8e850b90] libblastrampoline_jll v5.15.0+0
  [8e850ede] nghttp2_jll v1.70.0+0
  [3f19e933] p7zip_jll v17.8.3+0
Info Packages marked with ⌅ have new versions available but compatibility constraints restrict them from upgrading. To see why use `status --outdated -m`

You can also download the manifest file and the project file.