繁体   English   中英

如何用并行过程记录模拟?

[英]How to document simulations with parallel processes?

我一直在使用适用于Python的SimPy模块-执行离散事件模拟。 现在,代码已经变得相当庞大,并且有许多并行发生的进程彼此交互。

用文件证明这一点的最佳方法是什么? 类层次结构不能充分捕获流程之间的交互,并且几乎所有自动生成软件都陷于这样一个事实,即所有代码都有效地继承自SimPy模块,因此为每个类生成了完整的SimPy文档:/

我想像UML这样的东西可能有用,但是我对此不太了解。 它需要捕获:

  • 工艺流程
  • 大事记
  • 队列(包括等待资源的进程... :)
  • 资源(如可以填充/填充的数组等,具有一定的容量)

那么,基本上,有没有简洁的仿真代码记录工具?

干杯

UML具有状态图和活动图以及序列图。 这些中的任何一个都是合适的。 通常,需要组合图。

每个对象类别都有一个状态图。 http://en.wikipedia.org/wiki/State_diagram

活动图或序列图,用于显示对象之间的特定交互或协作。 http://www.agilemodeling.com/artifacts/activityDiagram.htm http://www.ibm.com/developerworks/rational/library/3101.html

类图也适合于显示类的静态特征及其关系。 http://en.wikipedia.org/wiki/Class_diagram

“整体”通常难以记录。

结合使用图表和自写的散文。

恕我直言,您不需要使用UML。 如果某些非UML以更清晰/更简单的方式传达您的消息,请使用您喜欢的任何东西。

还要写一个简短的摘要,其中包含所有基本概念,以使读者有个通俗的想法,系统的意图是什么,系统的主要组成部分是什么。

然后写有关每个组件的更详细的文章,并交叉引用其他文章。

Jacob Kaplan-Moss 撰写的文章系列写作卓越文档对我有很大帮助。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM