Creating a Version Controlled Library - MapleSim Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.

Online Help

All Products    Maple    MapleSim


Creating a Version Controlled Library

Version controlled libraries use the .base_msimlib file format. This format creates separate files for the components and attachments in your library, making it easier to track changes using a revision control system.

There are two ways to create a version controlled library: from a blank library or from an existing version controlled model.

To create a version controlled library from a blank library:

1. 

Select File > New > Library.

2. 

Under Package enter a name for the library. The name must be unique and cannot contain spaces. No other custom library or Modelica-imported library can share the package name.

3. 

Select a directory to save the library in from the Location list. (You cannot edit the entries in this list. See the notes section for information on how to add entries to the Location list.)

4. 

Select Version Controlled.

5. 

Optionally, enter a description.

6. 

Click OK.  A custom palette with the specified name appears in the Library Components tab ( ). This palette will appear in the window the next time you start MapleSim.  Custom palettes are indicated with an icon:

To save an existing version controlled model as a version controlled library:

1. 

Open a version controlled MapleSim model.

2. 

From the Tools menu, select Export to MapleSim Library.

3. 

Under Package enter a name for the library.  The name must be unique and cannot contain spaces.  No other custom library or Modelica-imported library can share the package name.

4. 

Select a directory to save the library in from the Location list. (You cannot edit the entries in this list. See the notes section for information on how to add entries to the Location list.)

5. 

Optionally, enter a description.

6. 

Click OK.  A custom palette with the specified name appears in the Library Components tab ( ). This palette will appear in the window the next time you start MapleSim.  Custom palettes are indicated with an icon:

 

You are now in library edit mode. The Properties tab ( ) on the right of the main MapleSim window summarizes the name, location, description, and creation date of your custom library.  Additionally, a watermark with the library's name is displayed on the workspace.

Notes:

• 

A new directory is created with the name you entered in the File name field. In this directory is a <modelname>.base_msim file, where <modelname> is the name you entered in the File name field, and two subdirectories called Attachments and Components.

• 

After you have created your model, you can control what changes to save by enabling and using the selective save feature. For more information, see The Selective Save Feature.

• 

Custom libraries are saved to a default location.  To save a custom library to a different location, you must add the following flag to the maplesimlauncher.l4j.ini file:
-DMapleSim.LibraryPath=pathnames
where pathnames is a string containing one or more locations.  On Windows, for example, this flag could be -DMapleSim.LibraryPath="C:/myLib;Z:/shared/MapleSimLibs"
When MapleSim is started with this flag, the Create Library dialog will list these two library location paths in addition to the default location.
The maplesimlauncher.l4j.ini file is located in the <Maple>/toolbox/MapleSim/bin.<SYS> folder, where <Maple> is your Maple installation directory and <SYS> is your system platform (for example, X86_64_WINDOWS).

• 

You can only create a version controlled custom library from a version controlled MapleSim model. If you want to convert a standard model (.msim) to a version controlled custom library, you must first convert the model to a version controlled model. For more information, see Creating a Version Controlled Model.

See Also

Revision Control Support for Models and Libraries

Version Controlled MapleSim Model File Format

Creating a Version Controlled Model

Opening a Version Controlled Model or Library

Adding an Attachment to a Custom Library

Creating a Custom Library from a Model

Creating Custom Modeling Components

Converting a Subsystem into a Shared Subsystem

Displaying a Previously Hidden Custom Library

Exporting a Custom Library to a Model

Generating Custom Library Documentation

Hiding or Deleting a Custom Library 

Importing Modelica Models and Libraries

The MapleSim Window

Updating a Custom Library

Using Custom Libraries