User Tools

Site Tools


library

This is an old revision of the document!


Library

The module library is an integrated “database” for sub-system modules. Any sub-system can be added to the library, so that it can be re-used later on in other projects.

Modules are organized in the library in a normal file structure with folders and files.

Creating a library file *.ecl*

After creating number of sub-systems in a Ecolego project (*.eco), or several projects with sub-systems there might be a need to pack them in a library, and send to other users, or save them for later use. To create a library file, user has to:

  1. Open Ecolego;
  2. Go to File → Library → Manage library;
  3. Press Select Library Folder button and specify folder with projects that should be packed in the library *ecl file;
  4. Mark the the projects (that contains sub-systems) or folders with projects that should be extracted as library using ctrl or shirt keys on the keyboard;
  5. Click on Export button;
  6. Add the name to the library (for example MyFirstLibrary.ecl).

This file can be later imported as a library with the same “Manage library” window, with the button named Import. Please pay attention that if you will try to import same projects to the same folder that they were extracted from, you will get error because of same names conflict.

Adding sub-systems to the library

From the Projects window:

  • Right-click the sub-system in the project tree and select Add to library from the popup menu.

From the Model window:

  • Right-click the sub-system in the matrix and select Add to library from the popup menu.
  • Right-click the sub-system in the graph and select Add to library from the popup menu.

Note that the sub-system must be “collapsed”.

The library window

The library dialog lets you select a folder for the module and modify some information:

  • Library - Select a folder with Select library folder button. List of modules is initially empty, until folder which contains projects (*.eco) was specified or library files have been imported to the library. To add additional folder, right-click in this list and select New;
  • Name - Give a name for your module. If the name is the same as a module in the same folder, that module will be overwritten;
  • Image - Click to select an image for the module. The image will be displayed in the library list.
  • Description - Enter a description for the module. It is recommended that the description includes the following information:
    • Overview - A brief description of what the module is for
    • Context - A comment on which cases, or in which context, the module is suitable for. For instance, details on what materials it supports.

Click Ok to add the module.

Retrieving sub-systems from the library

From the Projects window:

  • Right-click the target sub-system in the project tree and select Get from library from the pop-up menu.

From the Model window:

  • Right-click an empty cell in the matrix and select Get from library from the pop-up menu.
  • Right-click an empty place in the graph and select Get from library from the pop-up menu.

The library window

The library list let you navigate the library hierarchy. Once a module is selected, information about it will be displayed in the fields to the right.

Click Ok to add the module.

Caution! When adding a module from the library to a project that already contains modules, Ecolego will search for input/output names in the new module that matches the input/output names of the existing modules. If matches are found, the user will be prompted if he wants to automatically connect these. This is only recommended for users that are familiar with the library modules - mistakes are easily made unless the module library is carefully constructed.

Managing the library

To manage the library, select File | Library | Manage library….

The library window lets you change module information and create, rename or delete folders. It also lets you import a library or export the library.

  • New - Create a new folder, useful for importing projects to new folders;
  • Delete - Delete the currently selected folder with all content (projects, libraries, etc);
  • Import… - Import a new library folder from a *.ecl file;
  • Export… - Export the currently selected projects or folders to a *.ecl file;
  • Library - Lists all folders and modules. Select a folder or module to edit it’s properties;
  • Name - Click to change the name of the currently selected folder or module;
  • Image - Click to change the image of the currently selected module;
  • Description - Click to change the description of the currently selected module.

See also

library.1643024869.txt.gz · Last modified: 2022/01/24 12:47 by dmytroh