Engee 文档

使用工程师文档

页面进行中。

Engee文档不仅仅是一个参考,而是一个完整的导航器,用于整个平台的功能。 它涵盖了基本主题(如运行应用程序或基本建模)和高级场景,如集成第三方代码,将其生成为外部语言,可视化和连接外部设备。

working with docs 1

因此,在使用*Engee*时,可能会出现各种问题。:如何正确组装模型,如何实现控制系统,如何嵌入神经网络,或者如何在节奏上运行半自然模拟。 所有这一切都已经在文档中详细描述,但为了不浪费时间随机浏览其部分,从一开始就理解是很重要的:

  • 文档结构如何工作;

  • 在哪里可以找到适合特定任务的材料;

  • 如何使用内置示例和课程;

  • 如何使用内置搜索快速找到答案;

  • 如果文档中出现问题,如何留下反馈。

本文将帮助您快速习惯文档,了解其结构,学习如何有效地搜索正确的材料并充分利用平台。

如何打开文档

*Engee*文档可以通过各种方式打开,既可以从浏览器打开,也可以直接从工作区打开。:

  • 通过浏览器-最通用的方式:按照链接 https://engee.com/helpcenter/stable/ru/index.html. 这将立即打开主文档页面,在任何设备上工作,并且不需要启动Engee会话。

  • 从您的个人帐户-在您的主页上 个人帐户 account icon *Engee文档*按钮可用。 点击一下—你立即在文档中。 这便于快速访问信息,也不需要启动Engee会话。

    working with docs 3

  • 从正在运行的Engee会话-有几种方法可以直接从Engee工作区导航到所需的部分*:

    • 启动平台时,如果启用了*"始终在启动时显示"*复选标记,则会话启动时,将在"开始"窗口中显示指向热门文档部分的链接。:

      working with docs 4

    • 按钮 文件 documentation icon —位于界面的右上角,可从任何窗口访问。

      working with docs 5

    • 块的上下文菜单-双击来自 图书馆 block library icon 并在打开的设置窗口 设置窗口 debug article icon 1 在标签中 信息 选择*"文档"* working with docs 7 -块上的相应文章将打开:

      working with docs 6

      要打开设置窗口,没有必要将块放在画布上,双击将在库本身工作。 block library icon.

文档结构

*Engee*文档被组织成几个部分。 所有可用的部分及其页面都显示在文档的左侧菜单中。:

working with docs 2

任何部分通过单击鼠标左键打开其内容。 接下来,让我们简要回顾一下这些部分。:

  • *关于Engee*是学习平台文档的第一个切入点。 它描述了*Engee*是什么以及它是如何工作的。 工作区,如何使用 申请 apps icon 以及如何 使用您的个人帐户。 要熟悉该平台,建议从文章开始 快速启动.

  • 应用程序-一个关于各种任务的Julia语言包的文档部分。 本节介绍了用于处理统计、机器学习、优化、神经网络、信号和图像处理、雷达、通信、地图和许多其他有用领域的软件包。

  • 计算环境-本节面向处理代码的工程师和程序员。 它描述了数学,数据导入,图构造,Julia语法,第三方代码的集成等等。

  • 建模和仿真环境-本节介绍了有关创建和管理模型的所有内容:可视化建模、块库、软件仿真管理、有限自动机和半自然建模。

  • 培训课程-套 互动脚本主要主题:编程,建模,数学,信号处理,优化,电气和能源系统的建模,DSP,ACS等。 有关使用课程的更多信息,请参阅文章 如何获取教材.

    working with docs 8

    课程也可以直接从文档页面启动,只需单击所需课程页面上的"在Engee中打开示例"即可:

    working with docs 9

  • *代码生成*是那些想要将模型导出到程序代码的人的关键部分。 它包括关于c,HDL,Julia广播的材料,设置自定义生成模板和实际示例。

  • 示例-通过单击*"在Engee中打开"*启动的交互式演示。 在带有示例的主页面上,每个交互式块在悬停时显示与所选区域相关的前三个示例。 这是快速熟悉基本功能和典型工作场景的便捷方式。:

    working with docs 10

    与此同时,关于特定主题(无线电通信,信号处理,力学等)的所有可用示例的完整列表。)位于左侧菜单的小节中。:

    working with docs 11

  • 附加材料-描述与Git、Engee API的交互以及术语词典的使用。

  • 新增功能-更改和更新平台的历史记录。 在安装新版本后跟踪以了解添加了哪些功能,改进了哪些功能以及修复了哪些错误非常有用。

文档中的文章是如何安排的?

彩色条

许多文章使用颜色编码的文本栏来帮助您快速浏览信息类型。 他们每个人都告诉你如何感知突出显示的信息。:

包含附加信息或上下文。 它是可选的,但它有助于更好地理解主题。 你可以阅读以获得一般的理解和开阔你的视野.

有用的建议,技巧和提示。 它们有助于简化工作、加快操作或更有效地使用功能。

关键点,没有这些关键点,所描述的动作的执行可能是不正确的。 请务必在继续之前阅读它-它可能是参数,数据或一系列操作的要求。

有关风险的警告:错误,错误操作或数据丢失的可能性。 在做所描述的事情时,它们需要特别注意和准确.

有关潜在危险行为的警告。 这种模具用于执行可能导致关键故障、项目损坏或不安全系统行为的情况。 应最大限度地谨慎行事。

副标题的菜单

文章中的所有小标题都显示在文档的右侧菜单中。 只需左键单击所需标题的名称,文章就会自动转移到所需的主题。:

working with docs 12

这可以帮助您快速导航到所需的部分-在长页面上特别方便。

您可以共享文章特定部分的链接:只需将鼠标悬停在副标题上,链接图标就会出现在其左侧。 通过点击它,您将向页面的URL添加锚点。 您可以将此URL发送给同事或将其保存以快速导航到文章中的特定点。

working with docs 13

"有经验的用户"部分

有时会有标记为"For advanced users"的模具:

advanced users cn

这意味着这些部分包含复杂或罕见的工作场景:非标准库的集成,高级模拟参数的使用,自定义模板设置等。 这些部分对于执行/研究是可选的,但对于有经验的开发人员和爱好者来说可能是有用的。

文件检索

文档右上方有一个搜索栏。 她支持:

working with docs 14

  • 快速预览结果;

  • 相关文章的链接;

  • 能够转到*"所有结果"*以使用侧面菜单中的过滤器并优化查询:

    working with docs 15

    working with docs 16

如果您无法立即找到所需内容,请使用高级搜索!

界面语言和本地化

在右上角的搜索栏旁边,有一个用于切换文档语言的按钮。 默认情况下启用俄语,但如果需要,您可以选择英语或中文。:

working with docs 19

此外,选项*"英语块本地化"*可在下面找到。 激活后,库中的块和部分的名称以英文显示。 对于那些从事英语项目或更喜欢英语术语的人来说,这可能很方便。

如何报告错误

如果您注意到文章中的不准确或错字:

  1. 用鼠标左键选择有问题的文本片段;

  2. 等待几秒钟—如果您发现错误,将出现一个链接,其中包含文本*"。.."*:

    working with docs 17

  3. 点击它打开一个发送消息的表单。:

    working with docs 18

这将直接将信息发送给文档开发人员!