Skip to content

Adding an external library

The Modelon Impact installation process includes an option to install the complete set of Modelon libraries covering various industries and physical domains. This is done by the system administrator for Modelon Impact on-premise, and is described further in the operations manual. The system administrator can select to enable all Modelon libraries in all user workspaces, or let the user configure this per-workspace using Modelon Impact Workspace Management. As a user, it is also possible to add your own libraries. Libraries can be added either in a single workspace, or for all workspaces, see below.

Adding a Library to a Workspace🔗

Libraries can be added to a single workspace in different ways. If existing version controlled libraries are to be used, see section Add Version Controlled Libraries. If the libraries to use are not already under version control, they can be imported into Modelon Impact.

Import Libraries in Modelon Impact🔗

Libraries which are not under version control can be imported into Modelon Impact using the import button:

Modelica models (.mo), zipped structured Modelica libraries (.zip), and Functional Mock-up Units (FMUs) are supported. This will import the library as a local library in your workspace, not shared with other users.

Add Version Controlled Libraries🔗

There are different options for adding libraries which are already under version control to a Modelon Impact workspace for Modelon Impact on-premise and Modelon Impact Desktop, see below.

Modelon Impact on-premise🔗

For Modelon Impact on-premise, version controlled libraries can conveniently be added to a workspace in Modelon Impact using Modelon Impact Workspace Management. Through this plugin, users can check out the content they need from Subversion (SVN) or Git, and add configure their workspace with the wanted libraries. If the system administrator has set up per-workspace configuration of the Modelon Impact libraries, they can also add and remove these libraries to their workspace as needed. For more information, see the Workspace Management documentation.

Modelon Impact Desktop🔗

To add version controlled libraries with Modelon Impact Desktop, the libraries can either be linked through symbolic links as described in Use Version Control, or they can be checked out to the library folder on disk.

Adding a Library for all Workspaces🔗

A Modelica library can be enabled as a read-only library for all workspaces by adding it to the 'libraries' folder in the Modelon Impact artifacts folder structure.

Modelon Impact on-premise🔗

  1. Go to <storage>/impact/libraries, where <storage> is the persistent volume/storage used for Impact.
  2. Add the library to the libraries folder.
  3. Go to the 'Server Management' page to restart Modelon Impact (Environment variables -> Start Impact) if it is already running. The library should now be available in the library browser.

Note

The library is typically zipped (compressed). Unpack it and place the folder name, for example, Hydraulics, in the directory libraries. Once the Modelon Impact editing server is re-started, the library will be indexed first and it will be automatically renamed e.g. to Hydraulics xx.x, including the version, if a version is set in the library.

Modelon Impact Desktop🔗

  1. Go to C:/Users/<username>/impact/libraries.
  2. Add the library to the libraries folder.
  3. Restart Modelon Impact. The library should now be available in the library browser.

Upgrading a Library for all Workspaces🔗

Modelon Impact on-premise🔗

  1. Go to <storage>/impact/libraries.
  2. Find the library name, you would like to update (e.g. Hydraulics 10.2) and delete it.
  3. Add the new library folder to the libraries folder.
  4. Go to the 'Server Management' page to restart Modelon Impact (Environment variables -> Start Impact) if it is already running. The library should now be available in the library browser.

Modelon Impact Desktop🔗

  1. Go to C:/Users/<user_name>/impact/libraries.
  2. Find the library name, you would like to update (e.g. Hydraulics 10.2) and delete it.
  3. Add the new library folder to the libraries folder.
  4. Restart Modelon Impact.

Note

It is possible to have multiple versions of libraries within the libraries directory; Impact will allow users to pick the version they would like to use. Note however that version changes to global libraries may require a workspace upgrade if any of the models in the workspace are using any of the libraries for which the version was changed.