io.html 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>CBD.lib.io &mdash; CBD Simulation Development Kit documentation</title>
  8. <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
  9. <!-- <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> -->
  10. <link rel="stylesheet" href="../../../_static/style.css" type="text/css" />
  11. <link rel="index" title="Index" href="../../../genindex.html" />
  12. <link rel="search" title="Search" href="../../../search.html" />
  13. <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
  14. <script src="../../../_static/js/googleanalytics.min.js"></script>
  15. <script src="../../../_static/js/modernizr.min.js"></script>
  16. <!-- Preload the theme fonts -->
  17. <link rel="preload" href="../../../_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  18. <link rel="preload" href="../../../_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  19. <link rel="preload" href="../../../_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  20. <link rel="preload" href="../../../_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  21. <link rel="preload" href="../../../_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  22. <link rel="preload" href="../../../_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  23. <!-- Preload the katex fonts -->
  24. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Math-Italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  25. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  26. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  27. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size1-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  28. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size4-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  29. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size2-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  30. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size3-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  31. <link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Caligraphic-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
  32. </head>
  33. <div class="container-fluid header-holder tutorials-header" id="header-holder">
  34. <div class="container">
  35. <div class="header-container">
  36. <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
  37. <div class="main-menu">
  38. <ul>
  39. <li>
  40. <div class="ecosystem-dropdown">
  41. <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
  42. Ecosystem
  43. </a>
  44. <div class="ecosystem-dropdown-menu">
  45. <a class="nav-dropdown-item" href="https://alchemy.host">
  46. <span class=dropdown-title>Alchemy</span>
  47. <p>Experiments logging & visualization</p>
  48. </a>
  49. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
  50. <span class=dropdown-title>Catalyst</span>
  51. <p>Accelerated deep learning R&D</p>
  52. </a>
  53. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
  54. <span class=dropdown-title>Reaction</span>
  55. <p>Convenient deep learning models serving</p>
  56. </a>
  57. </div>
  58. </div>
  59. </li>
  60. <li>
  61. <div class="projects-dropdown">
  62. <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
  63. Projects
  64. </a>
  65. <div class="projects-dropdown-menu">
  66. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
  67. <span class=dropdown-title>Codestyle</span>
  68. <p>Joint R&D codestyle</p>
  69. </a>
  70. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
  71. <span class=dropdown-title>Catalyst.Neuro</span>
  72. <p>Catalyst.Team and TReNDS collaborative project</p>
  73. </a>
  74. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
  75. <span class=dropdown-title>Classification</span>
  76. <p>Image classification pipeline with transfer learning</p>
  77. </a>
  78. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
  79. <span class=dropdown-title>Detection</span>
  80. <p>Object detection pipeline</p>
  81. </a>
  82. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
  83. <span class=dropdown-title>Segmentation</span>
  84. <p>Image semantic segmentation pipeline</p>
  85. </a>
  86. <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
  87. <span class=dropdown-title>Catalyst.GAN</span>
  88. <p>GAN pipelines</p>
  89. </a>
  90. </div>
  91. </div>
  92. </li>
  93. <li>
  94. <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
  95. </li>
  96. </ul>
  97. </div>
  98. <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
  99. </div>
  100. </div>
  101. </div>
  102. <body class="catalyst-body">
  103. <div class="table-of-contents-link-wrapper">
  104. <span>Table of Contents</span>
  105. <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
  106. </div>
  107. <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
  108. <div class="catalyst-side-scroll">
  109. <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  110. <div class="catalyst-left-menu-search">
  111. <div role="search">
  112. <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
  113. <input type="text" name="q" placeholder="Search Docs" />
  114. <input type="hidden" name="check_keywords" value="yes" />
  115. <input type="hidden" name="area" value="default" />
  116. </form>
  117. </div>
  118. </div>
  119. <p class="caption"><span class="caption-text">Setup</span></p>
  120. <ul>
  121. <li class="toctree-l1"><a class="reference internal" href="../../../install.html">How to install the CBD framework?</a></li>
  122. <li class="toctree-l1"><a class="reference internal" href="../../../running.html">How to run a CBD simulation?</a></li>
  123. <li class="toctree-l1"><a class="reference internal" href="../../../changelog.html">Changelog</a></li>
  124. </ul>
  125. <p class="caption"><span class="caption-text">Simple Examples</span></p>
  126. <ul>
  127. <li class="toctree-l1"><a class="reference internal" href="../../../examples/SinGen.html">Sine Generator</a></li>
  128. <li class="toctree-l1"><a class="reference internal" href="../../../examples/EvenNumberGen.html">Hierarchical Even Number Generator</a></li>
  129. <li class="toctree-l1"><a class="reference internal" href="../../../examples/Fibonacci.html">Fibonacci Sequence Generator</a></li>
  130. <li class="toctree-l1"><a class="reference internal" href="../../../examples/LCG.html">Linear Congruential Generator</a></li>
  131. </ul>
  132. <p class="caption"><span class="caption-text">Advanced Examples</span></p>
  133. <ul>
  134. <li class="toctree-l1"><a class="reference internal" href="../../../examples/RealTime.html">Realtime Simulation</a></li>
  135. <li class="toctree-l1"><a class="reference internal" href="../../../examples/LivePlot.html">Live Plotting of Data During the Simulation</a></li>
  136. </ul>
  137. <p class="caption"><span class="caption-text">Internal Documentation</span></p>
  138. <ul>
  139. <li class="toctree-l1"><a class="reference internal" href="../../../CBD.html">CBD package</a></li>
  140. </ul>
  141. </div>
  142. </div>
  143. </nav>
  144. <div class="catalyst-container">
  145. <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
  146. <div class="catalyst-breadcrumbs-wrapper">
  147. <div role="navigation" aria-label="breadcrumbs navigation">
  148. <ul class="catalyst-breadcrumbs">
  149. <li>
  150. <a href="../../../index.html">
  151. Docs
  152. </a> &gt;
  153. </li>
  154. <li><a href="../../index.html">Module code</a> &gt;</li>
  155. <li>CBD.lib.io</li>
  156. <li class="catalyst-breadcrumbs-aside">
  157. </li>
  158. </ul>
  159. </div>
  160. </div>
  161. <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
  162. Shortcuts
  163. </div>
  164. </div>
  165. <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
  166. <div class="catalyst-content-left">
  167. <div class="rst-content">
  168. <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
  169. <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
  170. <h1>Source code for CBD.lib.io</h1><div class="highlight"><pre>
  171. <span></span><span class="sd">&quot;&quot;&quot;</span>
  172. <span class="sd">This module contains the library building blocks to handle</span>
  173. <span class="sd">input/output in the form of file interaction.</span>
  174. <span class="sd">&quot;&quot;&quot;</span>
  175. <span class="kn">from</span> <span class="nn">CBD.CBD</span> <span class="kn">import</span> <span class="n">BaseBlock</span>
  176. <span class="kn">import</span> <span class="nn">csv</span>
  177. <div class="viewcode-block" id="Interpolation"><a class="viewcode-back" href="../../../CBD.lib.io.html#CBD.lib.io.Interpolation">[docs]</a><span class="k">class</span> <span class="nc">Interpolation</span><span class="p">:</span>
  178. <span class="sd">&quot;&quot;&quot;</span>
  179. <span class="sd"> Helper class to handle CSV interpolations.</span>
  180. <span class="sd"> &quot;&quot;&quot;</span>
  181. <span class="n">FIRST</span> <span class="o">=</span> <span class="mi">0</span>
  182. <span class="sd">&quot;&quot;&quot;Use the first value to interpolate.&quot;&quot;&quot;</span>
  183. <span class="n">LAST</span> <span class="o">=</span> <span class="mi">1</span>
  184. <span class="sd">&quot;&quot;&quot;Use the last value to interpolate.&quot;&quot;&quot;</span>
  185. <span class="n">LINEAR</span> <span class="o">=</span> <span class="mi">2</span>
  186. <span class="sd">&quot;&quot;&quot;Do a linear interpolation between the two values.&quot;&quot;&quot;</span>
  187. <div class="viewcode-block" id="Interpolation.interpolate"><a class="viewcode-back" href="../../../CBD.lib.io.html#CBD.lib.io.Interpolation.interpolate">[docs]</a> <span class="nd">@staticmethod</span>
  188. <span class="k">def</span> <span class="nf">interpolate</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">t</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="n">FIRST</span><span class="p">):</span>
  189. <span class="sd">&quot;&quot;&quot;</span>
  190. <span class="sd"> Interpolates between two elements. When :code:`t` corresponds to :code:`a[0]`,</span>
  191. <span class="sd"> :code:`a[1]` will always be returned.</span>
  192. <span class="sd"> Args:</span>
  193. <span class="sd"> a (tuple): A pair :code:`(time, value)`; representing the first element.</span>
  194. <span class="sd"> b (tuple): A pair :code:`(time, value)`; representing the second element.</span>
  195. <span class="sd"> t (float): The time at which the interpolation happens.</span>
  196. <span class="sd"> method (int): The interpolation method to use.</span>
  197. <span class="sd"> Raises:</span>
  198. <span class="sd"> AssertionError: When :code:`a[0] &lt;= t &lt; b[0]` is not satisfied.</span>
  199. <span class="sd"> &quot;&quot;&quot;</span>
  200. <span class="k">assert</span> <span class="n">a</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">&lt;=</span> <span class="n">t</span> <span class="o">&lt;</span> <span class="n">b</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
  201. <span class="k">if</span> <span class="n">t</span> <span class="o">==</span> <span class="n">a</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
  202. <span class="k">return</span> <span class="n">a</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
  203. <span class="k">if</span> <span class="n">method</span> <span class="o">==</span> <span class="n">Interpolation</span><span class="o">.</span><span class="n">FIRST</span><span class="p">:</span>
  204. <span class="k">return</span> <span class="n">a</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
  205. <span class="k">if</span> <span class="n">method</span> <span class="o">==</span> <span class="n">Interpolation</span><span class="o">.</span><span class="n">LAST</span><span class="p">:</span>
  206. <span class="k">return</span> <span class="n">b</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
  207. <span class="k">if</span> <span class="n">method</span> <span class="o">==</span> <span class="n">Interpolation</span><span class="o">.</span><span class="n">LINEAR</span><span class="p">:</span>
  208. <span class="k">return</span> <span class="p">(</span><span class="n">b</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">a</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">/</span> <span class="p">(</span><span class="n">b</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="n">a</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">*</span> <span class="p">(</span><span class="n">t</span> <span class="o">-</span> <span class="n">a</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">+</span> <span class="n">a</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span></div></div>
  209. <div class="viewcode-block" id="ReadCSV"><a class="viewcode-back" href="../../../CBD.lib.io.html#CBD.lib.io.ReadCSV">[docs]</a><span class="k">class</span> <span class="nc">ReadCSV</span><span class="p">(</span><span class="n">BaseBlock</span><span class="p">):</span>
  210. <span class="sd">&quot;&quot;&quot;</span>
  211. <span class="sd"> Reads data from a CSV file and outputs it on the corresponding timestamps.</span>
  212. <span class="sd"> The output ports are defined by the read CSV columns.</span>
  213. <span class="sd"> Warning:</span>
  214. <span class="sd"> It is required to have a column that represents the time. Furthermore,</span>
  215. <span class="sd"> the dataset must be sorted w.r.t. this column.</span>
  216. <span class="sd"> Important:</span>
  217. <span class="sd"> When repeating, the last value of the CSV is used for time 0.0, hence it</span>
  218. <span class="sd"> is prohibited to use time 0 in your CSV.</span>
  219. <span class="sd"> Args:</span>
  220. <span class="sd"> block_name (str): The name of the block.</span>
  221. <span class="sd"> file_name (str): The name of the CSV to read.</span>
  222. <span class="sd"> hold (Interpolation): How the data should be interpreted if the time falls</span>
  223. <span class="sd"> in-between the records of the (sampled) CSV.</span>
  224. <span class="sd"> time_col (str): The name of the column identifying the time.</span>
  225. <span class="sd"> Defaults to :code:`&quot;time&quot;`.</span>
  226. <span class="sd"> repeat (bool): When :code:`True`, the CSV will repeat when at end.</span>
  227. <span class="sd"> Additionally, when the time is before the first time</span>
  228. <span class="sd"> in the file, an interpolation is done between the last</span>
  229. <span class="sd"> read and first read value. When :code:`False`, the</span>
  230. <span class="sd"> first and last values will be outputted when lower/higher</span>
  231. <span class="sd"> than the predefined range of times.</span>
  232. <span class="sd"> Defaults to :code:`False`.</span>
  233. <span class="sd"> Keyword Args:</span>
  234. <span class="sd"> columns (iter): A :class:`set`, :class:`list` or a :class:`dict`,</span>
  235. <span class="sd"> identifying all columns that need to be read. Must</span>
  236. <span class="sd"> correspond to the columns that can be found in the</span>
  237. <span class="sd"> file itself. When :code:`None` (default), all</span>
  238. <span class="sd"> columns from the first line of the file will be used.</span>
  239. <span class="sd"> In the case of a :class:`dict`, it is expected the</span>
  240. <span class="sd"> keys are the column names and the values refer to</span>
  241. <span class="sd"> the data types of these columns.</span>
  242. <span class="sd"> I.e. :code:`{ &quot;time&quot;: float }` reads the :code:`time`</span>
  243. <span class="sd"> column as floats.</span>
  244. <span class="sd"> For :class:`set` and :class:`list`, the data is read</span>
  245. <span class="sd"> as strings.</span>
  246. <span class="sd"> dtype: The default data type of the CSV. This does not override</span>
  247. <span class="sd"> optional values set by the :code:`columns` argument when it&#39;s</span>
  248. <span class="sd"> a :class:`dict`. Defaults to :code:`float`.</span>
  249. <span class="sd"> dialect (str): The dialect for parsing the data. Defaults to :code:`excel`.</span>
  250. <span class="sd"> nan (Any): The value to insert when some fields are missing data.</span>
  251. <span class="sd"> Defaults to :code:`None`.</span>
  252. <span class="sd"> **: For other values, take a look at the</span>
  253. <span class="sd"> `CSV Dialect and Formatting Parameters &lt;https://docs.python.org/3/library/csv.html#csv-fmt-params&gt;`_.</span>
  254. <span class="sd"> &quot;&quot;&quot;</span>
  255. <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">block_name</span><span class="p">,</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">hold</span><span class="o">=</span><span class="n">Interpolation</span><span class="o">.</span><span class="n">FIRST</span><span class="p">,</span> <span class="n">time_col</span><span class="o">=</span><span class="s2">&quot;time&quot;</span><span class="p">,</span> <span class="n">repeat</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
  256. <span class="bp">self</span><span class="o">.</span><span class="n">repeat</span> <span class="o">=</span> <span class="n">repeat</span>
  257. <span class="bp">self</span><span class="o">.</span><span class="n">time_col</span> <span class="o">=</span> <span class="n">time_col</span>
  258. <span class="bp">self</span><span class="o">.</span><span class="n">__read_file</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
  259. <span class="n">BaseBlock</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">block_name</span><span class="p">,</span> <span class="p">[],</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span>
  260. <span class="bp">self</span><span class="o">.</span><span class="n">hold</span> <span class="o">=</span> <span class="n">hold</span>
  261. <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
  262. <span class="k">def</span> <span class="nf">__read_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">columns</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">,</span> <span class="n">dialect</span><span class="o">=</span><span class="s1">&#39;excel&#39;</span><span class="p">,</span> <span class="n">nan</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
  263. <span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="p">{}</span>
  264. <span class="k">if</span> <span class="n">columns</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">time_col</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">columns</span><span class="p">:</span>
  265. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">columns</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
  266. <span class="n">columns</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">)</span>
  267. <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">columns</span><span class="p">,</span> <span class="nb">set</span><span class="p">):</span>
  268. <span class="n">columns</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">)</span>
  269. <span class="k">elif</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">columns</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
  270. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Invalid column iterable &#39;</span><span class="si">{}</span><span class="s2">&#39;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">columns</span><span class="p">)))</span>
  271. <span class="k">if</span> <span class="n">columns</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">columns</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
  272. <span class="n">columns</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">]</span> <span class="o">=</span> <span class="nb">float</span>
  273. <span class="n">dtype</span> <span class="o">=</span> <span class="nb">str</span>
  274. <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span>
  275. <span class="n">reader</span> <span class="o">=</span> <span class="n">csv</span><span class="o">.</span><span class="n">DictReader</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="n">restkey</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">restval</span><span class="o">=</span><span class="n">nan</span><span class="p">,</span> <span class="n">dialect</span><span class="o">=</span><span class="n">dialect</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
  276. <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">reader</span><span class="p">:</span>
  277. <span class="k">if</span> <span class="n">columns</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  278. <span class="n">columns</span> <span class="o">=</span> <span class="n">row</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
  279. <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">columns</span><span class="p">:</span>
  280. <span class="k">if</span> <span class="n">col</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">row</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
  281. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Unknown column &#39;</span><span class="si">{}</span><span class="s2">&#39; in CSV&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">col</span><span class="p">))</span>
  282. <span class="n">value</span> <span class="o">=</span> <span class="n">dtype</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="n">col</span><span class="p">])</span>
  283. <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">columns</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
  284. <span class="n">value</span> <span class="o">=</span> <span class="n">columns</span><span class="p">[</span><span class="n">col</span><span class="p">](</span><span class="n">value</span><span class="p">)</span>
  285. <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">col</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
  286. <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">])</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
  287. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;CSV is empty&quot;</span><span class="p">)</span>
  288. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">repeat</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mf">0.0</span><span class="p">:</span>
  289. <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;A repeating CSV series must not start at time 0&quot;</span><span class="p">)</span>
  290. <div class="viewcode-block" id="ReadCSV.compute"><a class="viewcode-back" href="../../../CBD.lib.io.html#CBD.lib.io.ReadCSV.compute">[docs]</a> <span class="k">def</span> <span class="nf">compute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">curIteration</span><span class="p">):</span>
  291. <span class="n">time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getClock</span><span class="p">()</span><span class="o">.</span><span class="n">getTime</span><span class="p">()</span>
  292. <span class="n">T</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
  293. <span class="n">L</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">])</span>
  294. <span class="k">if</span> <span class="n">L</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
  295. <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">:</span>
  296. <span class="bp">self</span><span class="o">.</span><span class="n">appendToSignal</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">col</span><span class="p">][</span><span class="mi">0</span><span class="p">],</span> <span class="n">col</span><span class="p">)</span>
  297. <span class="k">return</span>
  298. <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">repeat</span><span class="p">:</span>
  299. <span class="n">first_time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
  300. <span class="k">if</span> <span class="n">time</span> <span class="o">&lt;=</span> <span class="n">first_time</span><span class="p">:</span>
  301. <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">:</span>
  302. <span class="bp">self</span><span class="o">.</span><span class="n">appendToSignal</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">col</span><span class="p">][</span><span class="mi">0</span><span class="p">],</span> <span class="n">col</span><span class="p">)</span>
  303. <span class="k">return</span>
  304. <span class="k">elif</span> <span class="n">time</span> <span class="o">&gt;=</span> <span class="n">T</span><span class="p">:</span>
  305. <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">:</span>
  306. <span class="bp">self</span><span class="o">.</span><span class="n">appendToSignal</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">col</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="n">col</span><span class="p">)</span>
  307. <span class="k">return</span>
  308. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
  309. <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">=</span> <span class="mi">0</span>
  310. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
  311. <span class="n">next_time</span> <span class="o">=</span> <span class="n">last_time</span> <span class="o">=</span> <span class="mf">0.0</span>
  312. <span class="k">else</span><span class="p">:</span>
  313. <span class="n">next_time</span> <span class="o">=</span> <span class="n">last_time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">][</span><span class="bp">self</span><span class="o">.</span><span class="n">index</span><span class="p">]</span>
  314. <span class="k">while</span> <span class="n">next_time</span> <span class="o">&lt;=</span> <span class="n">time</span><span class="p">:</span>
  315. <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">+=</span> <span class="mi">1</span>
  316. <span class="n">last_time</span> <span class="o">=</span> <span class="n">next_time</span>
  317. <span class="n">next_time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">][</span><span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">%</span> <span class="n">L</span><span class="p">]</span> <span class="o">+</span> <span class="p">(</span><span class="n">T</span> <span class="o">*</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">//</span> <span class="n">L</span><span class="p">))</span>
  318. <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">-=</span> <span class="mi">1</span>
  319. <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">:</span>
  320. <span class="n">a</span> <span class="o">=</span> <span class="n">last_time</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">col</span><span class="p">][</span><span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">%</span> <span class="n">L</span><span class="p">]</span>
  321. <span class="n">b</span> <span class="o">=</span> <span class="n">next_time</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="n">col</span><span class="p">][(</span><span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">%</span> <span class="n">L</span><span class="p">]</span>
  322. <span class="bp">self</span><span class="o">.</span><span class="n">appendToSignal</span><span class="p">(</span><span class="n">Interpolation</span><span class="o">.</span><span class="n">interpolate</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">time</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">hold</span><span class="p">),</span> <span class="n">col</span><span class="p">)</span></div></div>
  323. <div class="viewcode-block" id="WriteCSV"><a class="viewcode-back" href="../../../CBD.lib.io.html#CBD.lib.io.WriteCSV">[docs]</a><span class="k">class</span> <span class="nc">WriteCSV</span><span class="p">(</span><span class="n">BaseBlock</span><span class="p">):</span>
  324. <span class="sd">&quot;&quot;&quot;</span>
  325. <span class="sd"> Outputs data to a CSV file.</span>
  326. <span class="sd"> Every time a message is received, a new record is added to the file. At the</span>
  327. <span class="sd"> end of the execution, when this block is destroyed, the file pointer will be</span>
  328. <span class="sd"> closed (and removed).</span>
  329. <span class="sd"> Args:</span>
  330. <span class="sd"> block_name (str): The name of the block.</span>
  331. <span class="sd"> filename (str): The name of the file to write to. All contents of this</span>
  332. <span class="sd"> file will be cleared.</span>
  333. <span class="sd"> columns (list): The (ordered) names of the columns in the file. These</span>
  334. <span class="sd"> generally represent the input ports for this block.</span>
  335. <span class="sd"> time_col (str): The name for the column to store the times. If this</span>
  336. <span class="sd"> corresponds to a value listed in the :code:`columns`</span>
  337. <span class="sd"> argument, that column will be used to keep track of the</span>
  338. <span class="sd"> time. There will **never** be an input port called</span>
  339. <span class="sd"> :code:`time_col`. If this value is not located in the</span>
  340. <span class="sd"> :code:`columns` list, a new column is added to the</span>
  341. <span class="sd"> front of the provided columns.</span>
  342. <span class="sd"> Defaults to :code:`&quot;time&quot;`.</span>
  343. <span class="sd"> :Keyword Arguments:</span>
  344. <span class="sd"> Take a look at the `csv.DictWriter &lt;https://docs.python.org/3/library/csv.html#csv.DictWriter&gt;`_</span>
  345. <span class="sd"> class for more info.</span>
  346. <span class="sd"> Tip:</span>
  347. <span class="sd"> When the time-value is not needed in the CSV, just ignore it when reading it out again.</span>
  348. <span class="sd"> &quot;&quot;&quot;</span>
  349. <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">block_name</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">columns</span><span class="p">,</span> <span class="n">time_col</span><span class="o">=</span><span class="s2">&quot;time&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
  350. <span class="n">BaseBlock</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">block_name</span><span class="p">,</span> <span class="p">[</span><span class="n">c</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">columns</span> <span class="k">if</span> <span class="n">c</span> <span class="o">!=</span> <span class="n">time_col</span><span class="p">],</span> <span class="p">[])</span>
  351. <span class="bp">self</span><span class="o">.</span><span class="n">file</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">)</span>
  352. <span class="bp">self</span><span class="o">.</span><span class="n">columns</span> <span class="o">=</span> <span class="n">columns</span>
  353. <span class="bp">self</span><span class="o">.</span><span class="n">time_col</span> <span class="o">=</span> <span class="n">time_col</span>
  354. <span class="k">if</span> <span class="n">time_col</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">columns</span><span class="p">:</span>
  355. <span class="n">columns</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">time_col</span><span class="p">)</span>
  356. <span class="bp">self</span><span class="o">.</span><span class="n">writer</span> <span class="o">=</span> <span class="n">csv</span><span class="o">.</span><span class="n">DictWriter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="p">,</span> <span class="n">columns</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
  357. <span class="bp">self</span><span class="o">.</span><span class="n">writer</span><span class="o">.</span><span class="n">writeheader</span><span class="p">()</span>
  358. <span class="k">def</span> <span class="fm">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  359. <span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
  360. <div class="viewcode-block" id="WriteCSV.compute"><a class="viewcode-back" href="../../../CBD.lib.io.html#CBD.lib.io.WriteCSV.compute">[docs]</a> <span class="k">def</span> <span class="nf">compute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">curIteration</span><span class="p">):</span>
  361. <span class="n">inputs</span> <span class="o">=</span> <span class="p">{</span> <span class="n">col</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">getInputSignal</span><span class="p">(</span><span class="n">curIteration</span><span class="p">,</span> <span class="n">col</span><span class="p">)</span><span class="o">.</span><span class="n">value</span> <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">columns</span> <span class="k">if</span> <span class="n">col</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">time_col</span> <span class="p">}</span>
  362. <span class="n">inputs</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">time_col</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getClock</span><span class="p">()</span><span class="o">.</span><span class="n">getTime</span><span class="p">()</span>
  363. <span class="bp">self</span><span class="o">.</span><span class="n">writer</span><span class="o">.</span><span class="n">writerow</span><span class="p">(</span><span class="n">inputs</span><span class="p">)</span></div></div>
  364. </pre></div>
  365. </article>
  366. </div>
  367. <footer>
  368. <hr>
  369. <div role="contentinfo">
  370. <p>
  371. &copy; Copyright 2020, Randy Paredis.
  372. </p>
  373. </div>
  374. <div>
  375. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  376. </div>
  377. </footer>
  378. </div>
  379. </div>
  380. <div class="catalyst-content-right" id="catalyst-content-right">
  381. <div class="catalyst-right-menu" id="catalyst-right-menu">
  382. <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
  383. </div>
  384. </div>
  385. </div>
  386. </section>
  387. </div>
  388. <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
  389. <script type="text/javascript" src="../../../_static/jquery.js"></script>
  390. <script type="text/javascript" src="../../../_static/underscore.js"></script>
  391. <script type="text/javascript" src="../../../_static/doctools.js"></script>
  392. <script type="text/javascript" src="../../../_static/language_data.js"></script>
  393. <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>
  394. <script type="text/javascript" src="../../../_static/js/vendor/popper.min.js"></script>
  395. <script type="text/javascript" src="../../../_static/js/vendor/bootstrap.min.js"></script>
  396. <script type="text/javascript" src="../../../_static/js/theme.js"></script>
  397. <script type="text/javascript">
  398. jQuery(function () {
  399. SphinxRtdTheme.Navigation.enable(true);
  400. });
  401. </script>
  402. <!-- Begin Footer -->
  403. <footer class="site-footer" id="site-footer">
  404. <div class="container footer-container">
  405. <div class="footer-logo-wrapper">
  406. <a href="https://catalyst-team.com/" class="footer-logo"></a>
  407. </div>
  408. <div class="footer-links-wrapper">
  409. <div class="footer-links-col">
  410. <ul>
  411. <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
  412. <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
  413. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
  414. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
  415. </ul>
  416. </div>
  417. <div class="footer-links-col">
  418. <ul>
  419. <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
  420. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
  421. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
  422. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
  423. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
  424. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
  425. <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
  426. </ul>
  427. </div>
  428. <div class="footer-links-col">
  429. <ul>
  430. <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
  431. <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
  432. <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
  433. <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
  434. </ul>
  435. </div>
  436. <div class="footer-links-col follow-us-col">
  437. <div class="footer-social-icons">
  438. <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
  439. <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
  440. <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
  441. </div>
  442. </div>
  443. </div>
  444. </div>
  445. </footer>
  446. <!-- End Footer -->
  447. <!-- Begin Mobile Menu -->
  448. <div class="mobile-main-menu">
  449. <div class="container-fluid">
  450. <div class="container">
  451. <div class="mobile-main-menu-header-container">
  452. <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
  453. <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
  454. </div>
  455. </div>
  456. </div>
  457. <div class="mobile-main-menu-links-container">
  458. <div class="main-menu">
  459. <ul>
  460. <li>
  461. <a href="">Get Started</a>
  462. </li>
  463. <li>
  464. <a href="https://github.com/catalyst-team/catalyst">Github</a>
  465. </li>
  466. </ul>
  467. </div>
  468. </div>
  469. </div>
  470. <!-- End Mobile Menu -->
  471. <script type="text/javascript" src="../../../_static/js/vendor/anchor.min.js"></script>
  472. <script type="text/javascript">
  473. $(document).ready(function() {
  474. mobileMenu.bind();
  475. mobileTOC.bind();
  476. catalystAnchors.bind();
  477. sideMenus.bind();
  478. scrollToAnchor.bind();
  479. highlightNavigation.bind();
  480. mainMenuDropdown.bind();
  481. // Add class to links that have code blocks, since we cannot create links in code blocks
  482. $("article.catalyst-article a span.pre").each(function(e) {
  483. $(this).closest("a").addClass("has-code");
  484. });
  485. })
  486. </script>
  487. </body>
  488. </html>