Engee documentation

Interface

When you start an Engee session, a workspace opens that includes the following elements:

interface 1 1 x

To display the modelling tools (#5, 6, 7, 8, 9, 10, 11), press the switch "Modeling environment" switch in Interface Settings interface setting 1 (#14):

interface admonition 1

  1. The canvas is the workspace on which the models are built;

  2. Programming section - a set of tools for working with code, consisting of script editor interactive script icon, command line img 41 1 2 and a window model diagnostics model diagnosis main;

  3. Files and Variables Section - a set of tools for working with files and variables, consisting of file browser file browser 7 and variable window variables article 2 1;

  4. Apps apps icon - a set of applications consisting of data inspector data inspector icon, RITM.Manager ritm icon , digital filter editor filter designer icon, Radar Equation Calculate radar equation calculator icon and Calculation of power grid modes calculation of the power grid modes icon . These applications open in a separate browser tab;

  5. Block Library block library icon - a set of blocks of Engee from which models are built;

  6. Simulation control section - a set of options for controlling the models. This panel is used to start start button, stop stop button 1, compile compile button 1 models and adjust their simulation time;

  7. Code generation codegen button - a tool for generating code from models. Generation is implemented for C, Chisel and Verilog (HDL) languages. Read more about code generation in Engee in the article Code generation;

  8. Switch target platform change platform button - switch workspace target platform between Engee (by default) and RITM.Manager. For more information about RITM operation in the Engee workspace, see the article Model settings;

  9. Model navigation panel - a panel for selecting the desired model and navigating through the hierarchy within a particular model;

  10. Model Data Editor model data editor - is a tool for managing model signals. For more details, see the article Model Data Editor;

  11. Settings and visualisation section - a set of tools consisting of physical variables window variable viewer icon, settings window debug article icon 1 and graphs window graphs icon 1;

  12. Account account icon - transition to personal cabinet of the user;

  13. Documentation documentation icon - go to documentation Engee;

  14. Interface settings interface setting 1 - a set of options for customising your workspace. Includes language selection, interface layout, and more;

  15. Feedback feedback icon - a tool for sending suggestions, bug reports, or requests for new features. It can also be used to restart the Engee kernel;

  16. Make screenshot screenshot icon - a tool for saving snapshots in PNG and SVG formats (not supported in Firefox). Also supported are bookmarks, which allow you to quickly navigate between models and their nesting levels;

  17. Scale Adjustment - adjusts the scale of the canvas without affecting the scale of the interface or browser;

  18. Status bar - displays the current state of the model, the selected solver, the simulation time and its progress. It also allows you to navigate to tabs settings windows debug article icon 1.

For quick navigation through the workspace and in each tool, we recommend to read the article on hotkeys Engee.

Customising the interface

In Engee you can customise the interface (the arrangement of windows on the canvas) yourself or use ready-made options:

  • To customise it yourself, move the desired window: left-click on it and drag it to one of the proposed locations in the workspace:

    interface variation 1

    Several tools can be placed together by dragging their titles with the left mouse button to the desired area:

    interface variation 2

    The window you want to work with can be enlarged by double-clicking its name with the left mouse button. Double-clicking again will return the window to its original position:

    interface variation 2 1

  • To select a ready-made window layout option, open the Interface settings interface setting 1 and in the tab Layouts select a suitable template:

    interface 10 1

A description of the tool options Interface settings interface setting 1 are presented below:

List of interface settings

  • Modelling Environment - enables/disables Engee modelling tools.

  • Language - switches the interface between Russian and English.

  • Dark Theme (experimental) - enables dark theme in the workspace.

  • Font Customisation - opens the Engee workspace font customisation window.

  • Window Layout - displays the preset variant of the interface:

    1. Standard standart scenario - opens the main tools of the Engee workspace, namely:

      • File Browser with variable and block library tabs;

      • Script editor and command line;

      • Graphs and settings windows.

    2. Programming programming scenario - opens the variables and script editor.

    3. Testing testing scenario - opens the script editor and the graph window.

    4. Modeling modeling scenario - opens the block library and settings.

    5. Simulation simulation scenario - closes all workspace tools.

    6. Save current layout - saves the Engee interface layout. It is possible to save multiple templates:

      layout 1 -> layout 2

  • Grid - includes a grid on the canvas.

  • All block labels - includes captions of model blocks.

Appearance

In addition to interface settings, you can control the appearance of the workspace:

  • Change the text and borders of model blocks:

    color settings 1

  • Change the size of interface fonts:

    font settings

  • Signalling signals:

    signal naming

  • Interface windows can be detached to open in a new browser window and moved across the entire monitor screen, not just within the Engee workspace:

    detachment 1

    detachment 2

  • Add annotations using markup to make the workspace more visual:

    annotation example x

  • Arrange tabs vertically in charts, settings, callbacks, and the script editor:

    vertical tabs 1 -> vertical tabs 2

  1. About Engee

  2. Quick start