/usr/share/doc/python-simpy-doc/html/Manuals/Tracing.html is in python-simpy-doc 2.3.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Simulation with Tracing — SimPy 2.3.1 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.3.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="SimPy 2.3.1 documentation" href="../index.html" />
<link rel="up" title="Manuals" href="../Manuals.html" />
<link rel="next" title="Simulation with Real Time Synchronization" href="SimRTManual.html" />
<link rel="prev" title="SimPy’s Object Oriented API" href="SimPyOO_API.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="SimRTManual.html" title="Simulation with Real Time Synchronization"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="SimPyOO_API.html" title="SimPy’s Object Oriented API"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">SimPy 2.3.1 documentation</a> »</li>
<li><a href="../Manuals.html" accesskey="U">Manuals</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="simulation-with-tracing">
<h1><a class="toc-backref" href="#id1">Simulation with Tracing</a><a class="headerlink" href="#simulation-with-tracing" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Authors:</th><td class="field-body"><ul class="first simple">
<li>Klaus Muller <<a class="reference external" href="mailto:Muller%40users.sourceforge.net">Muller<span>@</span>users<span>.</span>sourceforge<span>.</span>net</a>></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">SimPy release:</th><td class="field-body"><p class="first">2.3.1</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Web-site:</th><td class="field-body"><p class="first"><a class="reference external" href="http://simpy.sourceforge.net/">http://simpy.sourceforge.net/</a></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Python-Version:</th><td class="field-body"><p class="first">2.6 and later</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Date:</th><td class="field-body"><p class="first last">December 2011</p>
</td>
</tr>
</tbody>
</table>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#simulation-with-tracing" id="id1">Simulation with Tracing</a><ul>
<li><a class="reference internal" href="#introduction" id="id2">Introduction</a></li>
<li><a class="reference internal" href="#tracing-simpy-programs" id="id3">Tracing <em>SimPy</em> programs</a></li>
<li><a class="reference internal" href="#trace-tchange-changing-the-tracing" id="id4"><strong>trace.tchange()</strong>: Changing the tracing</a></li>
<li><a class="reference internal" href="#treset-resetting-the-trace-to-default-values" id="id5"><strong>treset()</strong>: Resetting the trace to default values</a></li>
<li><a class="reference internal" href="#trace-tstart-trace-tstop-enabling-disabling-the-trace" id="id6"><strong>trace.tstart()</strong>, <strong>trace.tstop()</strong>: Enabling/disabling the trace</a></li>
<li><a class="reference internal" href="#trace-ttext-annotating-the-trace" id="id7"><strong>trace.ttext()</strong>: Annotating the trace</a></li>
<li><a class="reference internal" href="#nice-output-of-class-instances" id="id8">Nice output of class instances</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="introduction">
<h2><a class="toc-backref" href="#id2">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>The tracing utility has been developed to give users insight into the
dynamics of the execution of SimPy simulation programs. It can help
developers with testing and users with explaining SimPy models to themselves
and others (e.g. for documentation or teaching purposes).</p>
</div>
<div class="section" id="tracing-simpy-programs">
<h2><a class="toc-backref" href="#id3">Tracing <em>SimPy</em> programs</a><a class="headerlink" href="#tracing-simpy-programs" title="Permalink to this headline">¶</a></h2>
<p>Tracing any <em>SimPy</em> program is as simple as replacing:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">SimPy.Simulation</span> <span class="kn">import</span> <span class="o">*</span>
</pre></div>
</div>
<p>with:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">SimPy.SimulationTrace</span> <span class="kn">import</span> <span class="o">*</span>
</pre></div>
</div>
<p>This will give a complete trace of all the scheduling statements
executed during the program’s execution.</p>
<p>An even nicer way is to replace this import by:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">if</span> <span class="n">__debug__</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">SimPy.SimulationTrace</span> <span class="kn">import</span> <span class="o">*</span>
<span class="k">else</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">SimPy.Simulation</span> <span class="kn">import</span> <span class="o">*</span>
</pre></div>
</div>
<p>This gives a trace during the development and debugging. If one then
executes the program with
<em>python -O myprog.py</em>, tracing is switched off, and no run-time
overhead is incurred. (<em>__debug__</em> is a
global Python constant which is set to False by commandline options -O
and -OO.)</p>
<p>For the same reason, any user call to <em>trace</em> methods should be written
as:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">if</span> <span class="n">__debug__</span><span class="p">:</span>
<span class="n">trace</span><span class="o">.</span><span class="n">ttext</span><span class="p">(</span><span class="s">"This will only show during debugging"</span><span class="p">)</span>
</pre></div>
</div>
<p>Here is an example (bank02.py from the Bank Tutorial):</p>
<div class="highlight-python"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26</pre></div></td><td class="code"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">SimPy.SimulationTrace</span> <span class="kn">import</span> <span class="o">*</span> <span class="c"># <== changed for tracing</span>
<span class="c">##from SimPy.Simulation import *</span>
<span class="sd">""" Simulate a single customer """</span>
<span class="k">class</span> <span class="nc">Customer</span><span class="p">(</span><span class="n">Process</span><span class="p">):</span>
<span class="sd">""" Customer arrives, looks around and leaves """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">name</span><span class="p">):</span>
<span class="n">Process</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="k">def</span> <span class="nf">visit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">timeInBank</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="k">print</span> <span class="s">"</span><span class="si">%7.4f</span><span class="s"> </span><span class="si">%s</span><span class="s">: Here I am"</span><span class="o">%</span><span class="p">(</span><span class="n">now</span><span class="p">(),</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">yield</span> <span class="n">hold</span><span class="p">,</span><span class="bp">self</span><span class="p">,</span><span class="n">timeInBank</span>
<span class="k">print</span> <span class="s">"</span><span class="si">%7.4f</span><span class="s"> </span><span class="si">%s</span><span class="s">: I must leave"</span><span class="o">%</span><span class="p">(</span><span class="n">now</span><span class="p">(),</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">model</span><span class="p">():</span>
<span class="n">initialize</span><span class="p">()</span>
<span class="n">c1</span><span class="o">=</span><span class="n">Customer</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">"Klaus"</span><span class="p">)</span>
<span class="n">activate</span><span class="p">(</span><span class="n">c1</span><span class="p">,</span><span class="n">c1</span><span class="o">.</span><span class="n">visit</span><span class="p">(</span><span class="n">timeInBank</span><span class="o">=</span><span class="mf">10.0</span><span class="p">),</span><span class="n">delay</span><span class="o">=</span><span class="mf">5.0</span><span class="p">)</span>
<span class="n">c2</span><span class="o">=</span><span class="n">Customer</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">"Tony"</span><span class="p">)</span>
<span class="n">activate</span><span class="p">(</span><span class="n">c2</span><span class="p">,</span><span class="n">c2</span><span class="o">.</span><span class="n">visit</span><span class="p">(</span><span class="n">timeInBank</span><span class="o">=</span><span class="mf">8.0</span><span class="p">),</span><span class="n">delay</span><span class="o">=</span><span class="mf">2.0</span><span class="p">)</span>
<span class="n">c3</span><span class="o">=</span><span class="n">Customer</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">"Evelyn"</span><span class="p">)</span>
<span class="n">activate</span><span class="p">(</span><span class="n">c3</span><span class="p">,</span><span class="n">c3</span><span class="o">.</span><span class="n">visit</span><span class="p">(</span><span class="n">timeInBank</span><span class="o">=</span><span class="mf">20.0</span><span class="p">),</span><span class="n">delay</span><span class="o">=</span><span class="mf">12.0</span><span class="p">)</span>
<span class="n">simulate</span><span class="p">(</span><span class="n">until</span><span class="o">=</span><span class="mf">400.0</span><span class="p">)</span>
<span class="n">model</span><span class="p">()</span>
</pre></div>
</td></tr></table></div>
<p>This program produces the following output:</p>
<div class="highlight-python"><pre>0 activate <Klaus> at time: 5.0 prior: 0
0 activate <Tony> at time: 2.0 prior: 0
0 activate <Evelyn> at time: 12.0 prior: 0
2.0000 Tony: Here I am
2.0 hold <Tony> delay: 8.0
5.0000 Klaus: Here I am
5.0 hold <Klaus> delay: 10.0
10.0000 Tony: I must leave
10.0 <Tony> terminated
12.0000 Evelyn: Here I am
12.0 hold <Evelyn> delay: 20.0
15.0000 Klaus: I must leave
15.0 <Klaus> terminated
32.0000 Evelyn: I must leave
32.0 <Evelyn> terminated</pre>
</div>
<p>Another example:</p>
<div class="highlight-python"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51</pre></div></td><td class="code"><div class="highlight"><pre><span class="sd">""" bank09.py: Simulate customers arriving</span>
<span class="sd"> at random, using a Source requesting service</span>
<span class="sd"> from several clerks but a single queue</span>
<span class="sd"> with a random servicetime</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">generators</span>
<span class="kn">from</span> <span class="nn">SimPy.SimulationTrace</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">random</span> <span class="kn">import</span> <span class="n">Random</span>
<span class="k">class</span> <span class="nc">Source</span><span class="p">(</span><span class="n">Process</span><span class="p">):</span>
<span class="sd">""" Source generates customers randomly"""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">seed</span><span class="o">=</span><span class="mi">333</span><span class="p">):</span>
<span class="n">Process</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">SEED</span> <span class="o">=</span> <span class="n">seed</span>
<span class="k">def</span> <span class="nf">generate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">number</span><span class="p">,</span><span class="n">interval</span><span class="p">):</span>
<span class="n">rv</span> <span class="o">=</span> <span class="n">Random</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">SEED</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">number</span><span class="p">):</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">Customer</span><span class="p">(</span><span class="n">name</span> <span class="o">=</span> <span class="s">"Customer</span><span class="si">%02d</span><span class="s">"</span><span class="o">%</span><span class="p">(</span><span class="n">i</span><span class="p">,))</span>
<span class="n">activate</span><span class="p">(</span><span class="n">c</span><span class="p">,</span><span class="n">c</span><span class="o">.</span><span class="n">visit</span><span class="p">(</span><span class="n">timeInBank</span><span class="o">=</span><span class="mf">12.0</span><span class="p">))</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">rv</span><span class="o">.</span><span class="n">expovariate</span><span class="p">(</span><span class="mf">1.0</span><span class="o">/</span><span class="n">interval</span><span class="p">)</span>
<span class="k">yield</span> <span class="n">hold</span><span class="p">,</span><span class="bp">self</span><span class="p">,</span><span class="n">t</span>
<span class="k">class</span> <span class="nc">Customer</span><span class="p">(</span><span class="n">Process</span><span class="p">):</span>
<span class="sd">""" Customer arrives, is served and leaves """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">name</span><span class="p">):</span>
<span class="n">Process</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="k">def</span> <span class="nf">visit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">timeInBank</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="n">arrive</span><span class="o">=</span><span class="n">now</span><span class="p">()</span>
<span class="k">print</span> <span class="s">"</span><span class="si">%7.4f</span><span class="s"> </span><span class="si">%s</span><span class="s">: Here I am "</span><span class="o">%</span><span class="p">(</span><span class="n">now</span><span class="p">(),</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">yield</span> <span class="n">request</span><span class="p">,</span><span class="bp">self</span><span class="p">,</span><span class="n">counter</span>
<span class="n">wait</span><span class="o">=</span><span class="n">now</span><span class="p">()</span><span class="o">-</span><span class="n">arrive</span>
<span class="k">print</span> <span class="s">"</span><span class="si">%7.4f</span><span class="s"> </span><span class="si">%s</span><span class="s">: Waited </span><span class="si">%6.3f</span><span class="s">"</span><span class="o">%</span><span class="p">(</span><span class="n">now</span><span class="p">(),</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span><span class="n">wait</span><span class="p">)</span>
<span class="n">tib</span> <span class="o">=</span> <span class="n">counterRV</span><span class="o">.</span><span class="n">expovariate</span><span class="p">(</span><span class="mf">1.0</span><span class="o">/</span><span class="n">timeInBank</span><span class="p">)</span>
<span class="k">yield</span> <span class="n">hold</span><span class="p">,</span><span class="bp">self</span><span class="p">,</span><span class="n">tib</span>
<span class="k">yield</span> <span class="n">release</span><span class="p">,</span><span class="bp">self</span><span class="p">,</span><span class="n">counter</span>
<span class="k">print</span> <span class="s">"</span><span class="si">%7.4f</span><span class="s"> </span><span class="si">%s</span><span class="s">: Finished"</span><span class="o">%</span><span class="p">(</span><span class="n">now</span><span class="p">(),</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">model</span><span class="p">(</span><span class="n">counterseed</span><span class="o">=</span><span class="mi">3939393</span><span class="p">):</span>
<span class="k">global</span> <span class="n">counter</span><span class="p">,</span><span class="n">counterRV</span>
<span class="n">counter</span> <span class="o">=</span> <span class="n">Resource</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">"Clerk"</span><span class="p">,</span><span class="n">capacity</span> <span class="o">=</span> <span class="mi">2</span><span class="p">)</span> <span class="c">#Lcapacity</span>
<span class="n">counterRV</span> <span class="o">=</span> <span class="n">Random</span><span class="p">(</span><span class="n">counterseed</span><span class="p">)</span>
<span class="n">initialize</span><span class="p">()</span>
<span class="n">sourceseed</span> <span class="o">=</span> <span class="mi">1133</span>
<span class="n">source</span> <span class="o">=</span> <span class="n">Source</span><span class="p">(</span><span class="n">seed</span> <span class="o">=</span> <span class="n">sourceseed</span><span class="p">)</span>
<span class="n">activate</span><span class="p">(</span><span class="n">source</span><span class="p">,</span><span class="n">source</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span><span class="mf">10.0</span><span class="p">),</span><span class="mf">0.0</span><span class="p">)</span>
<span class="n">simulate</span><span class="p">(</span><span class="n">until</span><span class="o">=</span><span class="mf">400.0</span><span class="p">)</span>
<span class="n">model</span><span class="p">()</span>
</pre></div>
</td></tr></table></div>
<p>This produces:</p>
<div class="highlight-python"><pre> 0 activate <a_process> at time: 0 prior: 0
0 activate <Customer00> at time: 0 prior: 0
0 hold <a_process> delay: 8.73140489458
0.0000 Customer00: Here I am
0 request <Customer00> <Clerk> priority: default
. . .waitQ: []
. . .activeQ: ['Customer00']
0.0000 Customer00: Waited 0.000
0 hold <Customer00> delay: 8.90355092634
8.73140489458 activate <Customer01> at time: 8.73140489458 prior: 0
8.73140489458 hold <a_process> delay: 8.76709801376
8.7314 Customer01: Here I am
8.73140489458 request <Customer01> <Clerk> priority: default
. . .waitQ: []
. . .activeQ: ['Customer00', 'Customer01']
8.7314 Customer01: Waited 0.000
8.73140489458 hold <Customer01> delay: 21.6676883425
8.90355092634 release <Customer00> <Clerk>
. . .waitQ: []
. . .activeQ: ['Customer01']
8.9036 Customer00: Finished
8.90355092634 <Customer00> terminated
17.4985029083 activate <Customer02> at time: 17.4985029083 prior: 0
. . . . .</pre>
</div>
<p>And here is an example showing the trace output for compound yield statements:</p>
<div class="highlight-python"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25</pre></div></td><td class="code"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">SimPy.SimulationTrace</span> <span class="kn">import</span> <span class="o">*</span>
<span class="k">class</span> <span class="nc">Client</span><span class="p">(</span><span class="n">Process</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">name</span><span class="p">):</span>
<span class="n">Process</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">getServed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">tank</span><span class="p">):</span>
<span class="k">yield</span> <span class="p">(</span><span class="n">get</span><span class="p">,</span><span class="bp">self</span><span class="p">,</span><span class="n">tank</span><span class="p">,</span><span class="mi">10</span><span class="p">),(</span><span class="n">hold</span><span class="p">,</span><span class="bp">self</span><span class="p">,</span><span class="mf">1.5</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">acquired</span><span class="p">(</span><span class="n">tank</span><span class="p">):</span>
<span class="k">print</span> <span class="s">"</span><span class="si">%s</span><span class="s"> got 10 </span><span class="si">%s</span><span class="s">"</span><span class="o">%</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span><span class="n">tank</span><span class="o">.</span><span class="n">unitName</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">print</span> <span class="s">"</span><span class="si">%s</span><span class="s"> reneged"</span><span class="o">%</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span>
<span class="k">class</span> <span class="nc">Filler</span><span class="p">(</span><span class="n">Process</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">name</span><span class="p">):</span>
<span class="n">Process</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">fill</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">tank</span><span class="p">):</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">):</span>
<span class="k">yield</span> <span class="n">hold</span><span class="p">,</span><span class="bp">self</span><span class="p">,</span><span class="mi">1</span>
<span class="k">yield</span> <span class="n">put</span><span class="p">,</span><span class="bp">self</span><span class="p">,</span><span class="n">tank</span><span class="p">,</span><span class="mi">10</span>
<span class="n">initialize</span><span class="p">()</span>
<span class="n">tank</span><span class="o">=</span><span class="n">Level</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">"Tank"</span><span class="p">,</span><span class="n">unitName</span><span class="o">=</span><span class="s">"gallons"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">2</span><span class="p">):</span>
<span class="n">c</span><span class="o">=</span><span class="n">Client</span><span class="p">(</span><span class="s">"Client </span><span class="si">%s</span><span class="s">"</span><span class="o">%</span><span class="n">i</span><span class="p">)</span>
<span class="n">activate</span><span class="p">(</span><span class="n">c</span><span class="p">,</span><span class="n">c</span><span class="o">.</span><span class="n">getServed</span><span class="p">(</span><span class="n">tank</span><span class="p">))</span>
<span class="n">f</span><span class="o">=</span><span class="n">Filler</span><span class="p">(</span><span class="s">"Tanker"</span><span class="p">)</span>
<span class="n">activate</span><span class="p">(</span><span class="n">f</span><span class="p">,</span><span class="n">f</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">tank</span><span class="p">))</span>
<span class="n">simulate</span><span class="p">(</span><span class="n">until</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</pre></div>
</td></tr></table></div>
<p>It produces this output:</p>
<div class="highlight-python"><pre>0 get <Client 0>to get: 10 gallons from <Tank> priority: default
. . .getQ: ['Client 0']
. . .putQ: []
. . .in buffer: 0
|| RENEGE COMMAND:
|| hold <Client 0> delay: 1.5
0 get <Client 1>to get: 10 gallons from <Tank> priority: default
. . .getQ: ['Client 0', 'Client 1']
. . .putQ: []
. . .in buffer: 0
|| RENEGE COMMAND:
|| hold <Client 1> delay: 1.5
0 hold <Tanker> delay: 1
0 hold <RENEGE-hold for Client 0> delay: 1.5
0 hold <RENEGE-hold for Client 1> delay: 1.5
1 put <Tanker> to put: 10 gallons into <Tank> priority: default
. . .getQ: ['Client 1']
. . .putQ: []
. . .in buffer: 0
1 hold <Tanker> delay: 1
Client 0 got 10 gallons
1 <Client 0> terminated
1.5 <RENEGE-hold for Client 1> terminated
Client 1 reneged
1.5 <Client 1> terminated
2 put <Tanker> to put: 10 gallons into <Tank> priority: default
. . .getQ: []
. . .putQ: []
. . .in buffer: 10
2 hold <Tanker> delay: 1
3 put <Tanker> to put: 10 gallons into <Tank> priority: default
. . .getQ: []
. . .putQ: []
. . .in buffer: 20
3 <Tanker> terminated</pre>
</div>
<p>In this example, the Client entities are requesting 10 gallons from the <em>tank</em> (a Level object).
If they can’t get them within 1.5 time units, they renege (give up waiting).
The renege command parts of the compound statements (<em>hold,self,1.5</em>)are shown
in the trace output with a prefix of || to indicate that they are being executed
in parallel with the primary command part (<em>get,self,tank,10</em>). They are being
executed by behind-the-scenes processes (e.g. <em>RENEGE-hold for Client 0</em>).</p>
<p>The trace contains all calls of scheduling statements (<strong>yield . . .</strong>,
<strong>activate()</strong>, <strong>reactivate()</strong>, <strong>cancel()</strong> and also the termination
of processes (at completion of all their scheduling statements). For
<strong>yield request</strong> and <strong>yield release</strong> calls, it provides also the queue
status (waiting customers in <em>waitQ</em> and customers being served in <em>activeQ</em>.</p>
</div>
<div class="section" id="trace-tchange-changing-the-tracing">
<h2><a class="toc-backref" href="#id4"><strong>trace.tchange()</strong>: Changing the tracing</a><a class="headerlink" href="#trace-tchange-changing-the-tracing" title="Permalink to this headline">¶</a></h2>
<p><strong>trace</strong> is an instance of the <strong>Trace</strong> class defined in <em>SimulationTrace.py</em>.
This gets automatically initialized upon importing <em>SimulationTrace</em>..</p>
<p>The tracing can be changed at runtime by calling <strong>trace.tchange()</strong> with one or
more of the following named parameters:</p>
<blockquote>
<div><p><em>start</em>:</p>
<blockquote>
<div>changes the tracing start time. Default is 0. Example: <strong>trace.tchange(start=222.2)</strong>
to start tracing at simulation time 222.2.</div></blockquote>
<p><em>end</em> :</p>
<blockquote>
<div>changes the tracing end time. Default is a very large number (hopefully past
any simulation endtime you will ever use).
Example: <strong>trace.tchange(end=33)</strong> to stop tracing at time 33.</div></blockquote>
<p><em>toTrace</em>:</p>
<blockquote>
<div>changes the commands to be traced. Default is
<em>[“hold”,”activate”,”cancel”,”reactivate”,”passivate”,”request”,
“release”,”interrupt”,”waitevent”,”queueevent”,
“signal”,”waituntil”,”put”,”get”,”terminated”]</em>.
Value must be a list containing
one or more of those values in the default. Note: “terminated” causes
tracing of all process terminations.
Example: <strong>trace.tchange(toTrace=[“hold”,”activate”])</strong> traces only the
<em>yield hold</em> and <em>activate()</em> statements.</div></blockquote>
<p><em>outfile</em>:</p>
<blockquote>
<div>redirects the trace out put to a file (default is <em>sys.stdout</em>). Value
must be a file object open for writing.
Example: <strong>trace.tchange(outfile=open(r”c:\python25\bank02trace.txt”,”w”))</strong></div></blockquote>
</div></blockquote>
<p>All these parameters can be combined.
Example: <strong>trace.tchange(start=45.0,toTrace=[“terminated”])</strong> will trace all
process terminations from time 45.0 till the end of the simulation.</p>
<p>The changes become effective at the time <strong>trace.tchange()</strong> is called. This
implies for example that, if the call <strong>trace.tchange(start=50)</strong> is made at time
100, it has no effect before <em>now()==100</em>.</p>
</div>
<div class="section" id="treset-resetting-the-trace-to-default-values">
<h2><a class="toc-backref" href="#id5"><strong>treset()</strong>: Resetting the trace to default values</a><a class="headerlink" href="#treset-resetting-the-trace-to-default-values" title="Permalink to this headline">¶</a></h2>
<p>The trace parameters can be reset to their default values by calling <strong>trace.treset()</strong>.</p>
</div>
<div class="section" id="trace-tstart-trace-tstop-enabling-disabling-the-trace">
<h2><a class="toc-backref" href="#id6"><strong>trace.tstart()</strong>, <strong>trace.tstop()</strong>: Enabling/disabling the trace</a><a class="headerlink" href="#trace-tstart-trace-tstop-enabling-disabling-the-trace" title="Permalink to this headline">¶</a></h2>
<p>Calling <strong>trace.tstart()</strong> enables the tracing, and <strong>trace.tstop()</strong>
disables it. Neither call changes any tracing parameters.</p>
</div>
<div class="section" id="trace-ttext-annotating-the-trace">
<h2><a class="toc-backref" href="#id7"><strong>trace.ttext()</strong>: Annotating the trace</a><a class="headerlink" href="#trace-ttext-annotating-the-trace" title="Permalink to this headline">¶</a></h2>
<p>The event-by-event trace output is already very useful in showing the sequence
in which SimPy’s quasi-parallel processes are executed.</p>
<p>For documentation, publishing or teaching purposes, it is even more useful
if the trace output can be intermingled with output which not only
shows the command executed, but also contextual information such as
the values of state variables. If one outputs the reason <em>why</em> a specific
scheduling command is executed, the trace can give a natural language description
of the simulation scenario.</p>
<p>For such in-line annotation, the <strong>trace.ttext(<string>)</strong> method is
available. It provides a string which is output together with the trace of
the next scheduling statement. This string is valid <em>only</em> for the scheduling
statement following it.</p>
<p>Example:</p>
<div class="highlight-python"><pre>class Bus(Process):
def __init__(self,name):
Process.__init__(self,name)
def operate(self,repairduration=0):
tripleft = 1000
while tripleft > 0:
trace.ttext("Try to go for %s"%tripleft)
yield hold,self,tripleft
if self.interrupted():
tripleft=self.interruptLeft
self.interruptReset()
trace.ttext("Start repair taking %s time units"%repairduration)
yield hold,self,repairduration
else:
break # no breakdown, ergo bus arrived
trace.ttext("<%s> has arrived"%self.name)
class Breakdown(Process):
def __init__(self,myBus):
Process.__init__(self,name="Breakdown "+myBus.name)
self.bus=myBus
def breakBus(self,interval):
while True:
trace.ttext("Breakdown process waiting for %s"%interval)
yield hold,self,interval
if self.bus.terminated(): break
trace.ttext("Breakdown of %s"%self.bus.name)
self.interrupt(self.bus)
print"\n\n+++test_interrupt"
initialize()
b=Bus("Bus 1")
trace.ttext("Start %s"%b.name)
activate(b,b.operate(repairduration=20))
br=Breakdown(b)
trace.ttext("Start the Breakdown process for %s"%b.name)
activate(br,br.breakBus(200))
trace.start=100
print simulate(until=4000)
This produces:
0 activate <Bus 1> at time: 0 prior: 0
---- Start Bus 1
0 activate <Breakdown Bus 1> at time: 0 prior: 0
---- Start the Breakdown process for Bus 1
200 reactivate <Bus 1> time: 200 prior: 0
200 interrupt by: <Breakdown Bus 1> of: <Bus 1>
---- Breakdown of Bus 1
200 hold <Breakdown Bus 1> delay: 200
---- Breakdown process waiting for 200
200 hold <Bus 1> delay: 20
---- Start repair taking 20 time units
220 hold <Bus 1> delay: 800
---- Try to go for 800
400 reactivate <Bus 1> time: 400 prior: 0
400 interrupt by: <Breakdown Bus 1> of: <Bus 1>
---- Breakdown of Bus 1
400 hold <Breakdown Bus 1> delay: 200
---- Breakdown process waiting for 200
400 hold <Bus 1> delay: 20
---- Start repair taking 20 time units
420 hold <Bus 1> delay: 620
. . . . .</pre>
</div>
<p>The line starting with “—-” is the comment related to the command traced
in the preceding output line.</p>
</div>
<div class="section" id="nice-output-of-class-instances">
<h2><a class="toc-backref" href="#id8">Nice output of class instances</a><a class="headerlink" href="#nice-output-of-class-instances" title="Permalink to this headline">¶</a></h2>
<p>After the import of <em>SimPy.SimulationTrace</em>, all instances of classes
<em>Process</em> and <em>Resource</em> (and all their subclasses) have a nice string
representation like so:</p>
<div class="highlight-python"><pre> >>> class Bus(Process):
... def __init__(self,id):
... Process.__init__(self,name=id)
... self.typ="Bus"
...
>>> b=Bus("Line 15")
>>> b
<Instance of Bus, id 21860960:
.name=Line 15
.typ=Bus
>
>>></pre>
</div>
<p>This can be handy in statements like <strong>trace.ttext(“Status of %s”%b)</strong>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/sm_SimPy_Logo.png" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Simulation with Tracing</a><ul>
<li><a class="reference internal" href="#introduction">Introduction</a></li>
<li><a class="reference internal" href="#tracing-simpy-programs">Tracing <em>SimPy</em> programs</a></li>
<li><a class="reference internal" href="#trace-tchange-changing-the-tracing"><strong>trace.tchange()</strong>: Changing the tracing</a></li>
<li><a class="reference internal" href="#treset-resetting-the-trace-to-default-values"><strong>treset()</strong>: Resetting the trace to default values</a></li>
<li><a class="reference internal" href="#trace-tstart-trace-tstop-enabling-disabling-the-trace"><strong>trace.tstart()</strong>, <strong>trace.tstop()</strong>: Enabling/disabling the trace</a></li>
<li><a class="reference internal" href="#trace-ttext-annotating-the-trace"><strong>trace.ttext()</strong>: Annotating the trace</a></li>
<li><a class="reference internal" href="#nice-output-of-class-instances">Nice output of class instances</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="SimPyOO_API.html"
title="previous chapter">SimPy’s Object Oriented API</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="SimRTManual.html"
title="next chapter">Simulation with Real Time Synchronization</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/Manuals/Tracing.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="SimRTManual.html" title="Simulation with Real Time Synchronization"
>next</a> |</li>
<li class="right" >
<a href="SimPyOO_API.html" title="SimPy’s Object Oriented API"
>previous</a> |</li>
<li><a href="../index.html">SimPy 2.3.1 documentation</a> »</li>
<li><a href="../Manuals.html" >Manuals</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2002-2011, Klaus Müller, Tony Vignaux, Ontje Lünsdorf, Stefan Scherfke.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
|