index.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <title>Welcome to Python(P)DEVS-BBL’s documentation! &#8212; Python(P)DEVS-BBL documentation</title>
  8. <link rel="stylesheet" href="_static/nature.css" type="text/css" />
  9. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  10. <link rel="stylesheet" type="text/css" href="_static/custom.css" />
  11. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  12. <script type="text/javascript" src="_static/jquery.js"></script>
  13. <script type="text/javascript" src="_static/underscore.js"></script>
  14. <script type="text/javascript" src="_static/doctools.js"></script>
  15. <script type="text/javascript" src="_static/language_data.js"></script>
  16. <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
  17. <link rel="index" title="Index" href="genindex.html" />
  18. <link rel="search" title="Search" href="search.html" />
  19. <link rel="next" title="pypdevsbbl package" href="pypdevsbbl.html" />
  20. </head><body>
  21. <div class="related" role="navigation" aria-label="related navigation">
  22. <h3>Navigation</h3>
  23. <ul>
  24. <li class="right" style="margin-right: 10px">
  25. <a href="genindex.html" title="General Index"
  26. accesskey="I">index</a></li>
  27. <li class="right" >
  28. <a href="py-modindex.html" title="Python Module Index"
  29. >modules</a> |</li>
  30. <li class="right" >
  31. <a href="pypdevsbbl.html" title="pypdevsbbl package"
  32. accesskey="N">next</a> |</li>
  33. <li class="nav-item nav-item-0"><a href="#">Python(P)DEVS-BBL documentation</a> &#187;</li>
  34. </ul>
  35. </div>
  36. <div class="document">
  37. <div class="documentwrapper">
  38. <div class="bodywrapper">
  39. <div class="body" role="main">
  40. <div class="section" id="welcome-to-python-p-devs-bbl-s-documentation">
  41. <h1>Welcome to Python(P)DEVS-BBL’s documentation!<a class="headerlink" href="#welcome-to-python-p-devs-bbl-s-documentation" title="Permalink to this headline">¶</a></h1>
  42. <div class="toctree-wrapper compound">
  43. </div>
  44. <p>Homepage of <code class="docutils literal notranslate"><span class="pre">Python(P)DEVS-BBL</span></code> (Python(P)DEVS Building Block Library).</p>
  45. <p>This library contains a set of DEVS building blocks that fit together like puzzle pieces,
  46. all of them running on top of the <code class="docutils literal notranslate"><span class="pre">PythonPDEVS</span></code> kernel. They propose a lot of functionality
  47. as a black box. With them, anyone can make models quickly, efficiently and fluently.</p>
  48. <p>No need to focus on the individual components anymore, allowing users to give 100% of their
  49. attention to the system they’re modelling!</p>
  50. <p>Note that <code class="docutils literal notranslate"><span class="pre">Python(P)DEVS-BBL</span></code> is additional code that is accompanied with my masters thesis. When in doubt
  51. about the usefulness or overall use-case, please take a look in the dissertation.</p>
  52. <p>There are a few parts available within <code class="docutils literal notranslate"><span class="pre">Python(P)DEVS-BBL</span></code>:</p>
  53. <div class="toctree-wrapper compound">
  54. <ul>
  55. <li class="toctree-l1"><a class="reference internal" href="pypdevsbbl.html">pypdevsbbl package</a><ul>
  56. <li class="toctree-l2"><a class="reference internal" href="pypdevsbbl.html#subpackages">Subpackages</a><ul>
  57. <li class="toctree-l3"><a class="reference internal" href="pypdevsbbl.domain.html">pypdevsbbl.domain package</a><ul>
  58. <li class="toctree-l4"><a class="reference internal" href="pypdevsbbl.domain.html#submodules">Submodules</a><ul>
  59. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.domain.gpss.html">pypdevsbbl.domain.gpss module</a></li>
  60. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.domain.industry.html">pypdevsbbl.domain.industry module</a></li>
  61. </ul>
  62. </li>
  63. </ul>
  64. </li>
  65. <li class="toctree-l3"><a class="reference internal" href="pypdevsbbl.extra.html">pypdevsbbl.extra package</a><ul>
  66. <li class="toctree-l4"><a class="reference internal" href="pypdevsbbl.extra.html#subpackages">Subpackages</a><ul>
  67. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.extra.rngstreams.html">pypdevsbbl.extra.rngstreams package</a><ul>
  68. <li class="toctree-l6"><a class="reference internal" href="pypdevsbbl.extra.rngstreams.html#submodules">Submodules</a></li>
  69. </ul>
  70. </li>
  71. </ul>
  72. </li>
  73. <li class="toctree-l4"><a class="reference internal" href="pypdevsbbl.extra.html#submodules">Submodules</a><ul>
  74. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.extra.equations.html">pypdevsbbl.extra.equations module</a></li>
  75. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.extra.fileutils.html">pypdevsbbl.extra.fileutils module</a></li>
  76. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.extra.heap.html">pypdevsbbl.extra.heap module</a></li>
  77. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.extra.mathutils.html">pypdevsbbl.extra.mathutils module</a></li>
  78. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.extra.packaging.html">pypdevsbbl.extra.packaging module</a></li>
  79. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.extra.queues.html">pypdevsbbl.extra.queues module</a></li>
  80. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.extra.spatial.html">pypdevsbbl.extra.spatial module</a></li>
  81. </ul>
  82. </li>
  83. </ul>
  84. </li>
  85. <li class="toctree-l3"><a class="reference internal" href="pypdevsbbl.generic.html">pypdevsbbl.generic package</a><ul>
  86. <li class="toctree-l4"><a class="reference internal" href="pypdevsbbl.generic.html#submodules">Submodules</a><ul>
  87. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.generic.collectors.html">pypdevsbbl.generic.collectors module</a></li>
  88. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.generic.generators.html">pypdevsbbl.generic.generators module</a></li>
  89. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.generic.io.html">pypdevsbbl.generic.io module</a></li>
  90. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.generic.math.html">pypdevsbbl.generic.math module</a></li>
  91. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.generic.queues.html">pypdevsbbl.generic.queues module</a></li>
  92. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.generic.routing.html">pypdevsbbl.generic.routing module</a></li>
  93. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.generic.transformers.html">pypdevsbbl.generic.transformers module</a></li>
  94. </ul>
  95. </li>
  96. </ul>
  97. </li>
  98. <li class="toctree-l3"><a class="reference internal" href="pypdevsbbl.tracers.html">pypdevsbbl.tracers package</a><ul>
  99. <li class="toctree-l4"><a class="reference internal" href="pypdevsbbl.tracers.html#submodules">Submodules</a><ul>
  100. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.tracers.FootprintTracer.html">pypdevsbbl.tracers.FootprintTracer module</a></li>
  101. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.tracers.PlotTracer.html">pypdevsbbl.tracers.PlotTracer module</a></li>
  102. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.tracers.ProfileTracer.html">pypdevsbbl.tracers.ProfileTracer module</a></li>
  103. <li class="toctree-l5"><a class="reference internal" href="pypdevsbbl.tracers.StatisticsTracer.html">pypdevsbbl.tracers.StatisticsTracer module</a></li>
  104. </ul>
  105. </li>
  106. </ul>
  107. </li>
  108. </ul>
  109. </li>
  110. </ul>
  111. </li>
  112. </ul>
  113. </div>
  114. <div class="section" id="tests">
  115. <h2>Tests<a class="headerlink" href="#tests" title="Permalink to this headline">¶</a></h2>
  116. <p>Additionally, since it is important that all code is tested, it is also possible to check
  117. the validity of the building blocks with the <code class="docutils literal notranslate"><span class="pre">test</span></code> package:</p>
  118. <div class="toctree-wrapper compound">
  119. <ul>
  120. <li class="toctree-l1"><a class="reference internal" href="test.html">test package</a><ul>
  121. <li class="toctree-l2"><a class="reference internal" href="test.html#subpackages">Subpackages</a><ul>
  122. <li class="toctree-l3"><a class="reference internal" href="test.extra.html">test.extra package</a><ul>
  123. <li class="toctree-l4"><a class="reference internal" href="test.extra.html#submodules">Submodules</a><ul>
  124. <li class="toctree-l5"><a class="reference internal" href="test.extra.test_distributions.html">test.extra.test_distributions module</a></li>
  125. <li class="toctree-l5"><a class="reference internal" href="test.extra.test_fileutils.html">test.extra.test_fileutils module</a></li>
  126. <li class="toctree-l5"><a class="reference internal" href="test.extra.test_heap.html">test.extra.test_heap module</a></li>
  127. <li class="toctree-l5"><a class="reference internal" href="test.extra.test_mathutils.html">test.extra.test_mathutils module</a></li>
  128. <li class="toctree-l5"><a class="reference internal" href="test.extra.test_packaging.html">test.extra.test_packaging module</a></li>
  129. </ul>
  130. </li>
  131. </ul>
  132. </li>
  133. <li class="toctree-l3"><a class="reference internal" href="test.generic.html">test.generic package</a><ul>
  134. <li class="toctree-l4"><a class="reference internal" href="test.generic.html#submodules">Submodules</a><ul>
  135. <li class="toctree-l5"><a class="reference internal" href="test.generic.test_collectors.html">test.generic.test_collectors module</a></li>
  136. <li class="toctree-l5"><a class="reference internal" href="test.generic.test_generators.html">test.generic.test_generators module</a></li>
  137. <li class="toctree-l5"><a class="reference internal" href="test.generic.test_io.html">test.generic.test_io module</a></li>
  138. <li class="toctree-l5"><a class="reference internal" href="test.generic.test_math.html">test.generic.test_math module</a></li>
  139. <li class="toctree-l5"><a class="reference internal" href="test.generic.test_queues.html">test.generic.test_queues module</a></li>
  140. <li class="toctree-l5"><a class="reference internal" href="test.generic.test_routing.html">test.generic.test_routing module</a></li>
  141. <li class="toctree-l5"><a class="reference internal" href="test.generic.test_transformers.html">test.generic.test_transformers module</a></li>
  142. </ul>
  143. </li>
  144. </ul>
  145. </li>
  146. </ul>
  147. </li>
  148. </ul>
  149. </li>
  150. </ul>
  151. </div>
  152. </div>
  153. </div>
  154. <div class="section" id="indices-and-tables">
  155. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
  156. <ul class="simple">
  157. <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
  158. <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
  159. <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
  160. </ul>
  161. </div>
  162. </div>
  163. </div>
  164. </div>
  165. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  166. <div class="sphinxsidebarwrapper">
  167. <h4>Next topic</h4>
  168. <p class="topless"><a href="pypdevsbbl.html"
  169. title="next chapter">pypdevsbbl package</a></p>
  170. <div id="searchbox" style="display: none" role="search">
  171. <h3>Quick search</h3>
  172. <div class="searchformwrapper">
  173. <form class="search" action="search.html" method="get">
  174. <input type="text" name="q" />
  175. <input type="submit" value="Go" />
  176. <input type="hidden" name="check_keywords" value="yes" />
  177. <input type="hidden" name="area" value="default" />
  178. </form>
  179. </div>
  180. </div>
  181. <script type="text/javascript">$('#searchbox').show(0);</script>
  182. </div>
  183. </div>
  184. <div class="clearer"></div>
  185. </div>
  186. <div class="related" role="navigation" aria-label="related navigation">
  187. <h3>Navigation</h3>
  188. <ul>
  189. <li class="right" style="margin-right: 10px">
  190. <a href="genindex.html" title="General Index"
  191. >index</a></li>
  192. <li class="right" >
  193. <a href="py-modindex.html" title="Python Module Index"
  194. >modules</a> |</li>
  195. <li class="right" >
  196. <a href="pypdevsbbl.html" title="pypdevsbbl package"
  197. >next</a> |</li>
  198. <li class="nav-item nav-item-0"><a href="#">Python(P)DEVS-BBL documentation</a> &#187;</li>
  199. </ul>
  200. </div>
  201. <div class="footer" role="contentinfo">
  202. &#169; Copyright 2020, Randy Paredis.
  203. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
  204. </div>
  205. </body>
  206. </html>