为包含LaTeX方程的Simulink模型生成报告万博1manbetx

发布的家伙卷轴，2021年12月27日

69次观看(过去30天)|0喜欢|0评论

            今天我很高兴欢迎客座博主
            莎拉·达恩
            ,从
            MathWorks咨询
            ．
           

            Sarah首先列出了Simulink中可用于记录设计的不同选项，并总结了最近添加的一个新功能:在S万博1manbetximulink Notes中使用LaTeX方程，它允许您自动生成报告，这要感谢
            万博1manbetxSimulink报告生成器API用于注释
            ！
           

简介

            虽然我们创建的模型的功能行为通常是展示的明星，但任何必须审查、测试或维护这些的人都知道文档可以成为真正的英雄。万博1manbetxSimulink提供了许多获取设计信息的方法，允许您创建文档;以下是一些例子:
           

块描述

            如果你右键单击任何块并选择“属性…”，General选项卡提供了一个“描述”字段。
           

            这也可以通过编程方式获取/设置:
           

注释

            双击Simulink画布可以创建注释。万博1manbetx创建注释之后，可以单击它的边缘并将其附加到块上。这也是可能的
            以编程方式创建注释
           

区域

            从左侧工具栏开始，可以创建区域。除了允许您输入描述之外，区域还允许您将其中的所有块作为一个组移动。
           

块注释

            块属性对话框允许您创建块注释。在块注释中，可以使用令牌来显示bock参数的值。
           

医生块

            的
            DocBlock
            是记录Simulink模型的另一个选项。万博1manbetx将块添加到任何子系统，双击它并开始键入。如果打开DocBlock的掩码参数，则可以将其配置为以文本、RTF或HTML的形式打开注释。
           

方程

            我们在Simulink中建模的大部分内容都是基于方万博1manbetx程的。虽然Simu万博1manbetxlink非常适合通过算法可视化数据流，但有时如果你能看到被建模的方程，就更容易理解发生了什么。
           

            虽然您可能习惯于看到用纯文本输入的方程式，但如果以手工书写的方式呈现，则会更容易理解——这就是为什么如此多的工程师和科学家喜欢TeX and的原因
            乳胶
            ！虽然MATLAB长期以来提供了解释TeX和LaTeX语法的方法，但在所有与Simulink设计相关的文档中都包含它可能是棘手的。万博1manbetx
           

            例如，您可以用方程创建Simulink画布注释:万博1manbetx
           

            然而，将这种类型的注释放入可能需要作为设计文档(例如系统设计说明(SDD))的报告中并不是很简单。SDD是高完整性认证工作流的一部分，例如for
            - 178 c吗
            所以这可能不仅仅是一个小烦恼。
           

模型指出

            笔记
            是为模型创建文档的另一种方法。注释保存在与模型不同的单独文件中，这与上面显示的其他注释技术不同。注释是上下文感知的，可以在整个模型层次结构中包含和显示子系统的内容。而且，笔记可以包含方程式!
           

            当其他人打开模型时，这将看起来像:
           

报告生成

            现在是时候把所有这些信息结合在一起了，这些信息对Simulink上下文非常敏感，包括数学方程和格式，并且可以在自动生成的、可移植的和完整的设计文档中使用万博1manbetx
            万博1manbetxSimulink报告生成器API用于注释
            ！
           

            对于上面截图中的模型，这段代码将生成一个PDF，其中包含子系统的截图，后面跟着注释，包括方程。
           

              模型=“mVdpEqn”；
             

              open_system(模型);
             

              进口mlreportgen.report。*
             

              进口slreportgen.report。*
             

              进口slreportgen.finder。*
             

              RPT = slreportgen.report。报告(模型+“_Notes_Report”，“pdf”）;
             

              打开(rpt);
             

              标题页=标题页(“标题”模型);
             

              add (rpt, titlepage);
             

              toc = TableOfContents();
             

              add (rpt, toc);
             

              finder = DiagramFinder(模型);
             

              而hasNext(仪)
             

              System = next(finder);
             

              ch =章节(“标题”, system.Name);
             

              添加(ch、系统);
             

              notes = notes(系统);
             

              添加(ch、笔记);
             

              add (rpt, ch);
             

              结束
             

              关闭(rpt);
             

              rptview (rpt);
             

现在轮到你了

            你在利用吗?
            万博1manbetxSimulink报告生成器
            r和
            万博1manbetx仿真软件的笔记
            记录您的设计并自动生成报告?请在下面的评论中告诉我们。
           