Engee documentation

Model development and debugging

The script is intended for building a model based on the description of the system, changing the existing scheme and finding the causes of calculation errors. Basic skill — engee_model.

Initial data

Specify the purpose of the model, equation or physical circuit, parameters with units of measurement, input effects and initial conditions. For an existing model, pass .engee or her path in the session. Add the calculation duration, step/solver requirements, required outputs, and acceptance criteria.

If some of the parameters are unknown, ask the agent to list them before calculating. The values accepted for the demonstration should be designated as assumptions.

Creating a model

  1. The agent checks and, if necessary, launches the environment, loads engee_model.

  2. Parses the description of the system, highlights the states, inputs, outputs and feedbacks.

  3. Creates a separate project directory in /user/, creates a model and immediately saves .engee.

  4. Finds blocks via block_search, specifies parameters and ports via block_info.

  5. Collects the circuit, sets the parameters, connections and location of the blocks.

  6. Adds To Workspace for the desired outputs with unique variable names.

  7. Performs calculation, receives data via collect, checks the numerical and physical correctness.

  8. Saves the model, results and report; issues files on request.

Example of a task

Создай в Engee модель апериодического звена `G(s) = 2 / (0.5s + 1)` с нулевым начальным состоянием. На вход подай единичную ступень в момент 0 с. Рассчитай 5 с и сохрани выход через To Workspace. Сравни его с `y(t) = 2(1 - exp(-t/0.5))`: максимальная абсолютная ошибка на согласованной сетке не должна превышать 0.01. Сохрани проект в `/user/FirstOrderDemo/`, выдай `.engee`, CSV, график и протокол проверки.

The numbers in this example are the formulation of a training test, and not the result of a simulation performed.

Debugging an existing model

Report the observed problem, expected behavior, startup conditions, and acceptable changes. For example:

Открой `/user/Drive/Drive.engee`. После запуска не появляются данные скорости. Найди причину через engee_diagnose, проверь To Workspace, имена переменных и логи инициализации. Не изменяй физические параметры. Исправленную модель сохрани отдельным файлом и подтверди результат повторным расчетом.

The agent must distinguish the error of the circuit construction from the absence of a customized data output and from numerical instability. The screenshot helps to check connections and readability; compliance with the criteria is confirmed by the data of the current run.

Readiness criteria

  • Saved .engee opens and contains the desired scheme.

  • The calculation is completed, non-empty data of the required signals are received.

  • The data is finite; the time step, units and ranges correspond to the task.

  • Comparison with the standard is performed according to the specified metrics and tolerances.

  • The report contains the actual settings, errors found, and remaining restrictions.

If you use your own algorithm, the agent can choose a skill engee_ngfunction_developement for Engee Function or engee_cfunction_developement for C Function. Such a block is tested in a test model with known inputs and boundary modes.