Engee documentation

Engee User Libraries

User libraries user library 1 are files with the .nglib extension that can contain any Engee blocks. These files allow you to use your own blocks from the Engee block library stateflow button library.

Creating your own libraries allows you to:

  • Store frequently used blocks in a convenient format to greatly simplify and speed up the modelling process;

  • Add required elements directly from the custom library, instead of creating new blocks for each model.

The advantages of custom libraries are their flexibility and usage. Such libraries help to standardise components, ensuring uniformity across models and reducing the possibility of errors. In addition, custom libraries make it easy to share developed blocks, which promotes more efficient teamwork and saves time.

To download other users' custom library files or upload your own, use Engee Remote Repository. For more information on how to work with the remote repository, see our articles on Git.
Once you have added your blocks to the Engee library, you will not be able to remove them while the session is active. To remove these blocks, you need to completely stop the Engee session and restart it. This will clear all user libraries, and if they are needed, they will have to be re-loaded.

To work with custom libraries:

  1. Create a .nglib library file in the Files window of file browser icon and give it the desired name:

    user lib create

  2. Create the desired block or subsystem in the Engee model. A subsystem allows you to store many blocks inside it at the same time. Therefore, to add a group of blocks to the library, combine them into a subsystem.

    user lib custom blocks

  3. Save the .nglib file in the file browser or navigation bar:

    user lib 2

    The directory in which a file is saved does not affect its location in the block library.

  4. To make blocks appear in the Engee library window stateflow button library, move the .nglib file to a folder and add it to the path using path editor:

    path editor new

  5. The added files will be placed in the User Libraries section, where the name of the .nglib file will become the name of the corresponding subsection:

    user lib save 1 1

  6. A previously created or loaded user library can also be accessed by searching the workspace:

    user lib 4

Tiered libraries

Large user libraries often require a nested structure - for example, when you want to categorise blocks into categories and subcategories. To do this, a special engee_library.toml file should be added to the library folder, which describes the structure of the hierarchy. An example of such a file:

image3

[metadata]
format_version = "1"

[[categories]]
lib_path = "/my-lib_upd"
files = ["foo/a.nglib", "foo/b.nglib"]

[[categories]]
lib_path = "/my-lib_upd/cat1"
files = ["c.nglib"]

[[categories]]
lib_path = "/my-lib_upd/cat1/cat2"
files = ["d.nglib"]

In this example:

  • format_version = "1" - the file format version.

  • lib_path - the path to the library section as it will be displayed in the Engee block library window stateflow button library.

  • files - list of .nglib files that will be loaded into this section.

    The files can be freely placed in different subdirectories - the main thing is that the paths in files should be specified correctly.

Thus, you can:

  • Group blocks into folders and subcategories (e.g. cat1 and cat2);

  • Load multiple files into a single section;

  • Clearly structure large libraries by subject, block type, etc.

After creating engee_library.toml and placing the required .nglib files in the specified folders, add the root library folder to Path via path editor and your hierarchy will appear in the block library window.

  1. File browser

  2. Data import

  3. First Steps. Creating a simple model