General glossary
Account
-
The term in Russian: Personal account
-
Definition: Section of Engee user account management. It sets up a profile, reviews and activates licenses, manages personal data and access to the platform.
For more information, see User account.
All block labels
-
The term in Russian: Signatures of all blocks
-
Definition: Switch for displaying block names on the canvas. It is useful when analyzing large models and preparing screenshots.
Annotations
-
The term in Russian: Annotations
-
Definition: Marked-up text notes (explanations, formulas, links) placed directly on the canvas. They increase the visibility of the model and facilitate collaboration. Markdown markup is supported with the possibility of extending the syntax using HTML and LaTeX.
For more information, see Annotations.
Apps
-
The term in Russian: Applications
-
Definition: The launcher of the built-in Engee applications (data inspector, RHYTHM, digital filter editor, etc.), which open in separate browser tabs. They are used for specialized analysis of modeling results, work with external equipment and additional calculations, complementing the basic capabilities of the canvas and the command line.
For more information, see Engee applications.
Autocomplete
-
The term in Russian: Auto-completion of commands
-
Definition: The mechanism of hints in the command line Engee and Julia. Using Tab It offers continuation options for variable names, functions, modules, file paths, and Engee commands. Speeds up code typing and reduces the risk of typos. When used for the first time in a session, it requires a double tap. Tab for initialization, after it works with one.
Block
-
The term in Russian: Block
-
Definition: The basic element of the Engee model. It represents a system component (source, handler, meter, etc.), its parameters and behavior; subsystems and complete circuits are assembled from the blocks. All available blocks are presented in block library Engee. You can also create custom blocks using masks and physical components, combining them into user libraries.
Block Library
-
The term in Russian: The library of blocks
-
Definition: Catalog of standard blocks Engee, from which models are assembled. It includes typical components of different domains (signal processing, physical systems, sources, meters, etc.) and provides unified access to them from the modeling interface.
You can also add custom blocks using custom libraries. For more information, see Engee User Libraries.
CAUTION
-
The term in Russian: Caution
-
Definition: Notifies about possible errors or risks if actions are performed inaccurately. It assumes increased accuracy and verification of the initial conditions.
Canvas
-
The term in Russian: Canvas
-
Definition: The main workspace Engee for assembling models. Blocks of are placed on the canvas block libraries Engee, create connections between them, configure parameters, and visually debug the system structure. It supports zooming, panning, and working with multiple subsystems, and much more.
For more information, see The first steps. Creating a simple model.
Charts
-
The term in Russian: Charts
-
Definition: A window for visualizing data generated by code from command line. Separate from model visualizations; new graphs open in tabs and do not overwrite each other. Supports fast browsing, zooming, exporting, and more.
For more information, see Charts.
Client program
-
The term in Russian: Client Program
-
Definition: A user-side application that executes the Python code of support packages and communicates with Engee over the RPC protocol.
Code generation
-
The term in Russian: Code generation
-
Definition: A tool for automatically obtaining source code from a model. The model code is converted to C, Chisel, Verilog/HDL, etc., and is used for integration with external projects and target platforms.
For more information, see Code generation.
Command Window
-
The term in Russian: Command Line
-
Definition: Julia-based interactive console for working with Engee. It executes code, creates and modifies models, runs simulations, manages packages, interacts with Git, and calls external editors. It supports special modes (help, shell, package manager, history search), which makes the command line a central tool for Engee software development.
For more information, see Command line.
Commit
-
The term in Russian: Commit
-
Definition: A fixed snapshot of the changes in the repository. It contains a set of modified files, metadata (author, time, link to the parent commit) and a message describing the essence of the changes. It is the main unit of history in Git.
Community of users
-
The term in Russian: Community
-
Definition: An item at the bottom of the documentation panel that opens access to the Engee community portal. The sections "Examples and Projects", "Questions and Answers" and "Engee Academy" are available on the portal. The materials can be viewed without authorization, and the publication of posts and comments is available to registered users.
For more information, see the website Communities and in the article Engee Community.
Condition Breakpoint
-
The term in Russian: Conditional breakpoint
-
Definition: Stops code execution only when the specified condition is met. The condition is set via the context menu of the point (for example:
i == 5).
Context Menu
-
The term in Russian: Context menu
-
Definition: A menu of actions for right-clicking on a file/folder or in an empty area. It contains operations for creating, renaming, downloading, archiving, deleting, etc.
Data inspector
-
The term in Russian: Data Inspector
-
Definition: The Engee application for analyzing the results of one or more simulations. It allows you to compare launches with each other, view and compare signals, filter and post-process data. It is convenient for studying the behavior of a model under different settings and input conditions.
For more information, see Data Inspector.
DataFrame
-
The term in Russian: DataFrame
-
Definition: The tabular structure from the package
DataFrames.jl. It can be used as a data source or receiver forWorkspaceArray: when creating (WorkspaceArray(name, df)) and when unloading (collect(wa)), which facilitates further processing and integration with analysis tools.
Device
-
The term in Russian: Device
-
Definition: A class of support package designed to work with external hardware or services. It does not use model data directly and encapsulates interaction with the device.
Diagnostic Message
-
The term in Russian: Diagnostic message
-
Definition: A record generated by the simulator or Engee subsystems. It contains the type of message, its text, and, if necessary, the context (model, block, port, execution stage). It is used to analyze the state of the model during startup and operation.
Dimension
-
The term in Russian: Signal dimension
-
Definition: The data form of the signal is a scalar, vector, matrix, or a more complex structure. It is used to check the correct connection of ports and to configure blocks that are waiting for inputs of a certain dimension.
Documentation
-
The term in Russian: Documentation
-
Definition: A button in the upper-right corner of the Engee interface that opens the section "Engee Documentation". It allows you to quickly navigate to reference pages, examples, and training materials without leaving a work session. It is convenient as an entry point to the description of blocks, functions and tools while working with the model.
Engee Integrations
-
The term in Russian: Engee.Integrations
-
Definition: Subsystem for interaction of Engee with external equipment. It works through a client program and support packages called from Julia, and provides data exchange between the model and devices.
For more information, see Engee.Integrations.
Engee support package
-
The term in Russian: Engee Support Package
-
Definition: Subsystem expansion Engee.Integrations, which adds the Engee library blocks for working with the I/O modules of the KPM "RHYTHM", as well as the following features software rhythm control directly from Engee.
Error Message
-
The term in Russian: Error
-
Definition: A critical problem that prevents the simulation from starting or executing correctly. The reasons include unconnected ports, type mismatch, or incorrect solver parameters. Requires mandatory correction.
Feedback
-
The term in Russian: Feedback
-
Definition: A window for sending messages to the Engee development team: suggestions for improvements, bug reports, requests for new features. It also includes service actions (for example, restarting the Engee kernel) and allows you to attach technical details (for example, model photos or code files) to simplify diagnostics.
File Browser
-
The term in Russian: File Browser
-
Definition: A tool for working with the project file structure in Engee. It allows you to view the contents of directories, create and delete files and folders, rename and move them, and archive selected items. It supports drag-and-drop, context menu and search bar, and integration with Git, which simplifies work and navigation in large projects.
For more information, see File Browser.
Filter Designer
-
The term in Russian: Digital Filter Editor
-
Definition: The Engee application for designing and configuring digital filters. Allows you to select the filter type, set parameters, analyze the response, and export the obtained coefficients for use in models or external systems.
For more information, see Digital Filter Editor.
Git
-
The term in Russian: Git
-
Definition: A distributed version control system used to track changes, maintain history, and collaborate on projects.
For more information, see Working with Git.
Git Integration
-
The term in Russian: Integration with Git
-
Definition: Version control directly from the file browser: commits, branches, push/pull, and working with remote repositories.
HIL (Hardware-in-the-Loop)
-
The term in Russian: Semi-natural modeling
-
Definition: A mode in which the object model is executed in real time and closes into a loop with real equipment: a controller, sensors, and actuators. It allows you to test control algorithms and interaction with hardware in conditions as close as possible to the operation of the system, without having to assemble a complete physical stand.
For more information, see the section Semi-natural modelling.
Help Mode
-
The term in Russian: Help mode
-
Definition: Command line mode for viewing the built-in documentation on functions/methods. Enter Shift+? and the function name (for example,
engee.save) for a brief reference. Exit the mode — Backspace or Ctrl+C.
History Search
-
The term in Russian: Search modes
-
Definition: Command line modes for command history search: reverse (Ctrl+R) and direct (Ctrl+S). Allows you to quickly find and re-execute previously entered commands. Exiting the modes — Backspace or Ctrl+C.
Hotkeys
-
The term in Russian: Keyboard shortcuts
-
Definition: Combinations for control navigation and workspace navigation Engee. To get help, use the combination Shift+? on the canvas.
For a more detailed list of keyboard shortcuts, see Engee Keyboard Shortcuts.
IMPORTANT
-
The term in Russian: Important
-
Definition: Indicates the conditions without which the procedure may fail or lead to an incorrect result. Requires mandatory attention before completing the step.
Info Message
-
The term in Russian: Information message
-
Definition: A message about regular simulation events (start, end, solver parameters, and other service information). It only requires familiarization.
Information
-
The term in Russian: Information
-
Definition: Section of the block card in settings window, where the "Documentation" button is located. Allows you to open an article of a specific block from the Library, both for the block placed on the model and by double—clicking on the block in the library.
Interactive Script
-
The term in Russian: Interactive script
-
Definition: A document with executable cells (code + text) inside Engee. Supports the format
.ngscript(recommended) and other script formats, and allows you to combine explanations (Markdown/LaTeX) with code in one structure. It is used for step-by-step experiments, prototyping, and documenting calculations right in the work environment. Edited using Script Editor.
Interface settings
-
The term in Russian: Interface Settings
-
Definition: Workspace Configuration panel Engee. It sets the language and theme of the design, fonts, window layouts, grid display and block captions, as well as the selection behavior. It supports saving user presets and quickly switching between different work scenarios (modeling, programming, analysis of results, etc.).
JULIA_LOAD_PATH
-
The term in Russian: JULIA_LOAD_PATH
-
Definition: A system variable that specifies a set of directories for searching for Julia packages. Used in conjunction with
LOAD_PATHto control the availability of libraries.For more information, see Code reuse.
LOAD_PATH
-
The term in Russian: LOAD_PATH
-
Definition: An array of paths that Julia uses to search for modules/packages when executing code. Allows you to connect dependencies without specifying absolute paths.
For more information, see Code reuse.
Language
-
The term in Russian: Language
-
Definition: Localization option (Russian/English). Affects the signatures of interface elements and hints.
Local repository
-
The term in Russian: Local repository
-
Definition: A copy of the repository on the developer’s machine, fully containing the project history (including
.git). Allows you to work offline and perform all Git operations locally.
Log
-
The term in Russian: Record
-
Definition: Recording option on the signal connection line between the units. Enabled recording allows you to display the selected signal in the window signal visualization.
For more information, see Recording signals in Engee.
Mask
-
The term in Russian: Masks (code cells)
-
Definition: Turning variables into interface elements (input field, list, slider, etc.) for interactive control of parameters without editing the code.
For more information, see Masks of code cells.
Model Data Editor
-
The term in Russian: Model Data Editor
-
Definition: Signal management tool in the Engee model. It shows a list of signals with their types, dimensions, and calculation step and allows you to enable/disable recording, rename signals, and navigate to the appropriate elements on the model.
For more information, see Model Data Editor.
Model Diagnostics Window
-
The term in Russian: Model diagnostic window
-
Definition: Engee workspace tool for displaying simulator system messages. It shows the progress of the simulation, warnings and errors and helps to quickly find problematic blocks, incorrect settings and incorrect parameters.
For more information, see Model diagnostics.
Model Navigation Panel
-
The term in Russian: Navigation panel for models
-
Definition: A tool for working with the model structure Engee. It shows a list of open models and their hierarchy and allows you to quickly switch between nesting levels.
For more information, see Navigation panel for models.
Model Reference
-
The term in Russian: The reference model
-
Definition: Block Model, connecting the external model as a reference. Allows you to link from one model to another to form a hierarchy of models. The block icon displays a representation of the link model content.
Modeling environment
-
The term in Russian: Simulation environment
-
Definition: The Engee operating mode switch. When turned on, it activates modeling tools (a library of blocks, graphs, model settings, etc.), when turned off, it hides them and leaves only programming and data manipulation tools. It is useful when you need to temporarily focus on code, analyzing results, or preparing data without the visual part of the model.
NOTE
-
The term in Russian: Note
-
Definition: An auxiliary plate with additional information or useful details. It is not mandatory, but it helps to better understand the context or features of the tool.
Path
-
The term in Russian: Path
-
Definition: A clickable route in the model data editor window that shows the location of the signal in the model and leads from the source to the associated blocks. It is highlighted on the model, and a double click centers the viewing area, making navigation and debugging easier.
For more information, see Model Data Editor.
Path Editor
-
The term in Russian: Path Editor
-
Definition: The Engee Search management tool is a list of directories in which the system searches for files when specifying a short path or just a name. In the editor, you can add folders, change the order in which they are crawled, and find files. The search is performed from top to bottom to the first match found, which allows you to precisely control the priority of file sources.
For more information, see Engee Path Editor.
Physical variables
-
The term in Russian: Physical variables
-
Definition: A window for analyzing initial conditions and target values in physical models Engee. It shows a list of physical quantities, the goal completion status, priorities, calculated initial values, and additional service information. The data is available for viewing only — changes are made through the parameters of the corresponding blocks.
For more information, see Physical variables.
Pkg Mode
-
The term in Russian: Batch Manager mode
-
Definition: Command line mode for managing Julia packages. Enter ] and manage packages using commands
add,update,rmand others . It is used to install libraries and expand the working environment. Exit the mode — Backspace or Ctrl+C.For more information, see Working with Julia packages.
Programmatic Modeling
-
The term in Russian: Software simulation management
-
Definition: Public methods for creating models and blocks, connections, parameter settings, and running simulations without leaving the command line/script editor. Hints on the methods are available through the help mode on the command line (Shift+?).
For more information, see Software control of modelling.
RITM support package
-
The term in Russian: RHYTHM Support Package
-
Definition: Firmware extension that adds features launching Engee models on real-time machines of KPM RITM.
RITM.Manager
-
The term in Russian: THE RHYTHM.Machine management
-
Definition: The Engee application for connecting and configuring KPM RITM real-time machines. It allows you to download and run real-time applications generated from Engee models, as well as manage hardware configuration and data exchange.
For more information, see RITM.Manager.
Record physical variables
-
The term in Russian: Record physical variables
-
Definition: Record values for blocks from the library physical modeling.
For more information, see the article Settings.
Release Notes
-
The term in Russian: What’s new
-
Definition: The official list of changes for each version of the Engee platform: new features, improvements, fixes, known issues, incompatible changes, and migration recommendations. It allows you to quickly understand what has changed in the release, how it affects the work, and what actions the user or developer may need.
For a full list of publications, see the link: What’s new.
Remote repository
-
The term in Russian: Remote repository
-
Definition: A repository hosted on a server (GitLab, GitHub, Bitbucket). It is used to share changes between participants and synchronize local work.
Repository
-
The term in Russian: Repository
-
Definition: Project history repository, which includes files, commits, branches, and tags. Contains a service folder
.git, where all information about the project version is located.
Ritm firmware
-
The term in Russian: RHYTHM firmware
-
Definition: The software framework of KPM "RHYTHM", which includes the RHYTHM operating system.RV, drivers, and libraries for interacting with I/O modules.
Scalar / Vector / Matrix
-
The term in Russian: Scalar / Vector / Matrix
-
Definition: Basic data forms in Engee and Julia. A scalar is a single value of any supported type (
Int64,Float64,Bool,String). A vector is a one—dimensional array of elements ([1, 2, 3]). The matrix is a two—dimensional array ([1 2; 3 4]).
Script Editor
-
The term in Russian: Script Editor
-
Definition: Engee Interactive Scripts window: create, edit, and run code and text in cells. Supports quick launch, masks, table of contents and output management, and more.
For more information, see Script Editor.
Script Editor Breakpoints
-
The term in Russian: Breakpoints of the script editor
-
Definition: A tool for temporarily stopping code execution in files
.ngscriptand.jl. It is used for step-by-step analysis, logic verification, and error detection. It only works inside script editor and differs from breakpoints in modeling (see Breakpoints in modeling).
Script Formats
-
The term in Russian: Script formats
-
Definition: Supported
.ngscript(native Engee format),.jl(Julia) and.ipynb(Jupyter). The format is selected when creating the file or changed via file browser.
Shell Mode
-
The term in Russian: Shell mode
-
Definition: Command line mode for executing Unix/Linux commands. Enter ; and work with Unix/Linux commands (
ls,cd,mv,rm,catand others). Exit the mode — Backspace or Ctrl+C.
Signal visualization
-
The term in Russian: Signal visualization
-
Definition: A tool for demonstrating the results of simulation of models Engee. It displays only recorded signals and supports several types of graphs and tabs.
For more information, see Signal visualization.
Simulation
-
The term in Russian: Simulation
-
Definition: The process of numerical calculation of the Engee model using the selected solver, settings, and input data. During the simulation, the model sequentially calculates the values of variables over time and generates the results for subsequent analysis and visualization.
Solver
-
The term in Russian: The Solver
-
Definition: A numerical algorithm that calculates the dynamic behavior of the Engee model based on its equations. Defines the calculation step and accuracy requirements, which directly affect the calculation speed and the quality of the result. An incorrectly selected solver or its settings may lead to an erroneous solution or too slow modeling. There is no universal solver "for all cases", so it is selected taking into account the task and the specifics of a particular model.
For more information, see Getting started with solvers in Engee.
Status Bar
-
The term in Russian: Status bar
-
Definition: The bottom panel displays key information about the current model: active solver, simulation time, simulation progress, and execution status messages. Access to related sections is available from here. settings window and other service tabs, which simplifies monitoring and diagnostics during model startup.
Subsystem
-
The term in Russian: Subsystem
-
Definition: Block Subsystem, created to work with the hierarchy of the model. There can be both an atomic (single) and a virtual subsystem.
For more information about working with subsystems in Engee, see the article Practical work with model architecture in Engee.
Support package
-
The term in Russian: Support Package
-
Definition: A custom Python module that is run by the client program and becomes available in Engee through automatically generated Julia wrappers. Expands the possibilities of integration with equipment or services.
System Object
-
The term in Russian: System object
-
Definition: An element of the Engee modeling environment designed for building and executing dynamic algorithms (communications, radar, DSP, control, etc.). It encapsulates the internal state and logic of data processing and follows a typical lifecycle: creation, configuration, inclusion in the processing chain and launch through
step!. It is used to build sequential paths and realistic simulation of signal processing.For more information, see Engee System Objects.
TIP
-
The term in Russian: The Council
-
Definition: A short recommendation that helps you perform an action faster or more conveniently (shortcuts, techniques, hidden features). Improves the efficiency of daily work.
Target
-
The term in Russian: Target
-
Definition: A class of support package that interacts with the Engee model and runs on an external platform (for example, on a microcontroller or a separate PC). It is used to implement parts of the model outside the main machine.
Terminal
-
The term in Russian: Terminal
-
Definition: A separate tab with the system shell (bash) for direct execution of Linux commands on the command line. It does not support command line modes. It opens from the command line header menu.
For more information, see Terminal.
Text Editors
-
The term in Russian: Text editor modes
-
Definition: Command line mode for launching popular text editors (vi/vim/nano) from shell mode, ;). Used to edit files directly on the command line. The basic syntax of the editors is presented in the lower command line menu after logging into the corresponding editor. For a full review, it is recommended to study the official documentation for the selected editor.
For more information, see Text editor modes.
Triggered Breakpoint
-
The term in Russian: A point that depends on another
-
Definition: It is triggered only after a certain "starting" breakpoint has been activated. It is used in step-by-step debugging scenarios where actions must occur in a strict sequence.
Tuple
-
The term in Russian: The Tuple
-
Definition: An immutable ordered collection of elements that can have different types. Supports it as a positional option
(1, 3.14, "hi"), and named(a = 1, b = 3.14), where access to the elements is possible by name (x.a). It is used for compact and secure transfer of related parameters and structured data.
Variables
-
The term in Russian: Variables
-
Definition: Engee tool for viewing and managing variables of the current session. It allows you to create variables via the command line and scripts, edit values and names, copy/delete entries, clear everything and restart the kernel.
For more information, see The window of variables.
WARNING
-
The term in Russian: Warning
-
Definition: Indicates potentially dangerous actions that may lead to failures, damage to the project, or malfunction of the system. It should be performed only with full understanding of the consequences and availability of backups.
Warning Message
-
The term in Russian: Warning
-
Definition: A message about a potential problem: incorrect settings, unused connections, possible inconsistencies of types or parameters. The simulation continues, but the results may be inaccurate; it is recommended to eliminate the cause before the final calculations.
Working directory
-
The term in Russian: Working directory
-
Definition: The current project files available on the disk. Their status may differ from the index and the last commit, which is important when preparing changes.
Workspace
-
The term in Russian: Work area
-
Definition: The data storage area of the current session Engee. It contains the simulation results, the variables being created, and other calculated values. Displayed in variable window and serves as a central place to access data between code runs, simulations, and analysis tools in Engee.
WorkspaceArray
-
The term in Russian: WorkspaceArray
-
Definition: A specialized array of time series in Engee with lazy loading of data. Implements the interface
AbstractArray, stores metadata (time and values) and downloads data only when accessed. It is convenient for working with large simulation results without excessive memory consumption.For more information, see Working with WorkspaceArray in Engee.
simout
-
The term in Russian: simout
-
Definition: A standard variable that is automatically created after simulation. It contains simulation results in the form of signals and time series, often represented as
WorkspaceArray, and is used for analysis and visualization.For more information, see Software processing of simulation results in Engee.