Skip to content

Add doc how to build external C libraries with CMake #4734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
beutlich wants to merge 1 commit into
base: master
Choose a base branch
from
+29 −0
Open

Add doc how to build external C libraries with CMake #4734

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,35 @@ Note, the usage of a Modelica library requires a Modelica simulation environment

![ModelicaLibraries](Modelica/Resources/Images/UsersGuide/ModelicaLibraries.png)

## Building the external C libraries

CMake is recommended as build system, which usually consists of three steps for configuration, build and installation. For example,

```console
git clone https://github.com/modelica/ModelicaStandardLibrary
cd ModelicaStandardLibrary
cmake -S ./Modelica/Resources -B .
cmake --build .
cmake --install .
```

The following Modelica Standard Library specific options for building with CMake are available.

* `MODELICA_BUILD_TESTING:BOOL=ON`
This flag enables the testsuite for CTest.
* `MODELICA_BUILD_ZLIB:BOOL=ON`
This flag enables the build of zlib dependency from source.
* `MODELICA_COPY_TABLE_DATA:BOOL=ON`
This flag avoids an undesired memory optimization of shallow-copying the passed table arrays.
Comment on lines +33 to +34
Copy link
Contributor

@HansOlsson HansOlsson Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This description is bit too cryptic for me, I had to read it more than once to understand which setting avoided the problems - and then think more to understand which problems.

I would suggest something like the following.

Suggested change
* `MODELICA_COPY_TABLE_DATA:BOOL=ON`
This flag avoids an undesired memory optimization of shallow-copying the passed table arrays.
* `MODELICA_COPY_TABLE_DATA:BOOL=ON`
Copy table data in constructor. Disabling this optimizes memory use, but requires that the caller keeps the data.

The second sentence could be skipped.

* `MODELICA_DEBUG_TIME_EVENTS:BOOL=OFF`
This flag enables tracing of time events.
* `MODELICA_DUMMY_FUNCTION_USERTAB:BOOL=OFF`
This flag adds a dummy function "usertab".
* `MODELICA_INSTALL_EXTC:BOOL=OFF`
This flag also installs the ModelicaExternalC target.
* `MODELICA_SHARE_TABLE_DATA:BOOL=ON`
This flag enables the memory optimization of avoiding redundant copies of table arrays read from file.

## Current release

[Modelica Standard Library v4.1.0 (2025-05-23)](https://github.com/modelica/ModelicaStandardLibrary/releases/tag/v4.1.0)
Expand Down