Added a lot of documentation

doc/CBD.CBD.rst

@@ -0,0 +1,7 @@
+CBD.CBD module
+==============
+
+.. automodule:: CBD.CBD
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.CBD2LaTeX.rst

@@ -0,0 +1,7 @@
+CBD.CBD2LaTeX module
+====================
+
+.. automodule:: CBD.CBD2LaTeX
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.src.CBD.rst

@@ -1,7 +1,7 @@
-CBD.src.CBD module
+CBD.CBDDraw module
 ==================
 
-.. automodule:: CBD.src.CBD
+.. automodule:: CBD.CBDDraw
     :members:
     :undoc-members:
     :show-inheritance:

doc/CBD.depGraph.rst

@@ -0,0 +1,7 @@
+CBD.depGraph module
+===================
+
+.. automodule:: CBD.depGraph
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.lib.interface.endpoints.rst

@@ -0,0 +1,7 @@
+CBD.lib.interface.endpoints module
+==================================
+
+.. automodule:: CBD.lib.interface.endpoints
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.lib.interface.plotting.rst

@@ -0,0 +1,7 @@
+CBD.lib.interface.plotting module
+=================================
+
+.. automodule:: CBD.lib.interface.plotting
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.lib.interface.rst

@@ -0,0 +1,16 @@
+CBD.lib.interface package
+=========================
+
+.. automodule:: CBD.lib.interface
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   CBD.lib.interface.endpoints
+   CBD.lib.interface.plotting
+

doc/CBD.lib.rst

@@ -0,0 +1,22 @@
+CBD.lib package
+===============
+
+.. automodule:: CBD.lib
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    CBD.lib.interface
+
+Submodules
+----------
+
+.. toctree::
+
+   CBD.lib.std
+

doc/_build/html/_sources/CBD.src.CBD.rst.txt

@@ -1,7 +1,7 @@
-CBD.src.CBD module
+CBD.lib.std module
 ==================
 
-.. automodule:: CBD.src.CBD
+.. automodule:: CBD.lib.std
     :members:
     :undoc-members:
     :show-inheritance:

doc/CBD.naivelog.rst

@@ -0,0 +1,7 @@
+CBD.naivelog module
+===================
+
+.. automodule:: CBD.naivelog
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.realtime.plotting.rst

@@ -0,0 +1,7 @@
+CBD.realtime.plotting module
+============================
+
+.. automodule:: CBD.realtime.plotting
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.realtime.rst

@@ -0,0 +1,19 @@
+CBD.realtime package
+====================
+
+.. automodule:: CBD.realtime
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   CBD.realtime.plotting
+   CBD.realtime.threadingBackend
+   CBD.realtime.threadingGameLoop
+   CBD.realtime.threadingPython
+   CBD.realtime.threadingTkInter
+

doc/CBD.realtime.threadingBackend.rst

@@ -0,0 +1,7 @@
+CBD.realtime.threadingBackend module
+====================================
+
+.. automodule:: CBD.realtime.threadingBackend
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.realtime.threadingGameLoop.rst

@@ -0,0 +1,7 @@
+CBD.realtime.threadingGameLoop module
+=====================================
+
+.. automodule:: CBD.realtime.threadingGameLoop
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.realtime.threadingPython.rst

@@ -0,0 +1,7 @@
+CBD.realtime.threadingPython module
+===================================
+
+.. automodule:: CBD.realtime.threadingPython
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.realtime.threadingTkInter.rst

@@ -0,0 +1,7 @@
+CBD.realtime.threadingTkInter module
+====================================
+
+.. automodule:: CBD.realtime.threadingTkInter
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.rst

@@ -1,64 +1,30 @@
 CBD package
 ===========
 
-Python-based framework for CBD modeling and simulation.
+.. automodule:: CBD
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-:Authors:
-  * Marc Provost
-  * Hans Vangheluwe
-  * Joachim Denil
-  * Claudio Gomes
-  * Randy Paredis
-
-:Python Version: >= 3.6
+Subpackages
+-----------
 
 .. toctree::
-   :maxdepth: 3
-
-   CBD.src
-
-Prerequisites
--------------
-The following packages are required to run simulations using this framework:
-
-* *Standard Python Modules:* :code:`unittest`, :code:`math`, :code:`collections` (for :code:`collections.namedtuple`),
-  :code:`os`, :code:`sys`, :code:`datetime`, :math:`re`
-* `bokeh <https://bokeh.org>`_ for plotting. To install bokeh for python, follow
-  `these instructions <https://bokeh.pydata.org/en/latest/docs/user_guide/quickstart.html#installation>`_.
-* `GraphViz <http://graphviz.org/>`_ to display the dependency structure of the CBD. To install Graphviz,
-  follow these steps:
-
-  1. Download and install Graphviz: https://www.graphviz.org/download/
-  2. Make sure the Graphviz binaries are accessible in the PATH environment variable.
-     For example, on windows there should be an entry in the PATH with: :file:`C:\\Graphviz2.38\\bin`
-  3. Install :code:`graphviz` for Python: https://graphviz.readthedocs.io/en/stable/manual.html
-
-    .. note:: For anaconda users, use https://anaconda.org/anaconda/graphviz
-
 
-Running the Tests
------------------
-From the root directory of the CBD Simulator Framework (i.e., where this README file resides), execute:
+    CBD.lib
+    CBD.realtime
 
-.. code-block:: bash
+Submodules
+----------
 
-    python3 -m unittest discover -v CBD.test "*.py"
-
-:code:`testDerivatorBlock` and :code:`testIntegratorBlock` will fail while working on the Discrete-Time CBD simulator.
-
-
-Running Examples
-----------------
-Make sure that PYTHONPATH includes the root directory of the CBD Simulator Framework.
-
-.. code-block:: bash
-
-    cd examples/EvenNumberGen/
-    python3 EvenNumberGen.py
-
-.. code-block:: bash
+.. toctree::
 
-    cd examples/Fibonacci/
-    python3 Fibonacci.py
+   CBD.CBD
+   CBD.CBD2LaTeX
+   CBD.CBDDraw
+   CBD.depGraph
+   CBD.naivelog
+   CBD.simulator
+   CBD.solver
+   CBD.util
 
-Both will generate an HTML document containing a bokeh plot in the current directory.

doc/CBD.simulator.rst

@@ -0,0 +1,7 @@
+CBD.simulator module
+====================
+
+.. automodule:: CBD.simulator
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.solver.rst

@@ -0,0 +1,7 @@
+CBD.solver module
+=================
+
+.. automodule:: CBD.solver
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.src.CBDDraw.rst

@@ -1,7 +0,0 @@
-CBD.src.CBDDraw module
-======================
-
-.. automodule:: CBD.src.CBDDraw
-    :members:
-    :undoc-members:
-    :show-inheritance:

doc/CBD.src.naivelog.rst

@@ -1,7 +0,0 @@
-CBD.src.naivelog module
-=======================
-
-.. automodule:: CBD.src.naivelog
-    :members:
-    :undoc-members:
-    :show-inheritance:

doc/CBD.src.rst

@@ -1,17 +0,0 @@
-CBD.src package
-===============
-
-.. automodule:: CBD.src
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
-
-   CBD.src.CBD
-   CBD.src.CBDDraw
-   CBD.src.naivelog
-

doc/CBD.util.rst

@@ -0,0 +1,7 @@
+CBD.util module
+===============
+
+.. automodule:: CBD.util
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/_build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 51539f9424eae19ae5fe1a9a81676885
+config: 1691210975960228245fd2357043d9cb
 tags: 645f666f9bcd5a90fca523b33c5a78b7

doc/_build/html/CBD.CBD.html

@@ -0,0 +1,975 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.CBD module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.CBD2LaTeX module" href="CBD.CBD2LaTeX.html" />
+    <link rel="prev" title="CBD.realtime.threadingTkInter module" href="CBD.realtime.threadingTkInter.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.CBD module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.CBD">
+<span id="cbd-cbd-module"></span><h1>CBD.CBD module<a class="headerlink" href="#module-CBD.CBD" title="Permalink to this headline">¶</a></h1>
+<dl class="class">
+<dt id="CBD.CBD.InputLink">
+<em class="property">class </em><code class="descclassname">CBD.CBD.</code><code class="descname">InputLink</code><span class="sig-paren">(</span><em>block</em>, <em>output_port</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.CBD.InputLink" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
+<dl class="attribute">
+<dt id="CBD.CBD.InputLink.block">
+<code class="descname">block</code><a class="headerlink" href="#CBD.CBD.InputLink.block" title="Permalink to this definition">¶</a></dt>
+<dd><p>Alias for field number 0</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="CBD.CBD.InputLink.output_port">
+<code class="descname">output_port</code><a class="headerlink" href="#CBD.CBD.InputLink.output_port" title="Permalink to this definition">¶</a></dt>
+<dd><p>Alias for field number 1</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.CBD.Signal">
+<em class="property">class </em><code class="descclassname">CBD.CBD.</code><code class="descname">Signal</code><span class="sig-paren">(</span><em>time</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.CBD.Signal" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
+<dl class="attribute">
+<dt id="CBD.CBD.Signal.time">
+<code class="descname">time</code><a class="headerlink" href="#CBD.CBD.Signal.time" title="Permalink to this definition">¶</a></dt>
+<dd><p>Alias for field number 0</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="CBD.CBD.Signal.value">
+<code class="descname">value</code><a class="headerlink" href="#CBD.CBD.Signal.value" title="Permalink to this definition">¶</a></dt>
+<dd><p>Alias for field number 1</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.CBD.BaseBlock">
+<em class="property">class </em><code class="descclassname">CBD.CBD.</code><code class="descname">BaseBlock</code><span class="sig-paren">(</span><em>name</em>, <em>input_ports</em>, <em>output_ports</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>A base class for all types of basic blocks</p>
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getBlockName">
+<code class="descname">getBlockName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getBlockName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getBlockName" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the name of the block.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.setBlockName">
+<code class="descname">setBlockName</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.setBlockName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.setBlockName" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the name of the block.</p>
+<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">Parameters:</th><td class="field-body"><strong>block_name</strong> (<em>str</em>) – The name.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.setParent">
+<code class="descname">setParent</code><span class="sig-paren">(</span><em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.setParent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.setParent" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the block’s parent.</p>
+<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">Parameters:</th><td class="field-body"><strong>parent</strong> (<a class="reference internal" href="#CBD.CBD.CBD" title="CBD.CBD.CBD"><em>CBD</em></a>) – The parent of the block.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getBlockType">
+<code class="descname">getBlockType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getBlockType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getBlockType" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the type of the block. This is the name of the class.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getLinksIn">
+<code class="descname">getLinksIn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getLinksIn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getLinksIn" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the inputs of this block.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getOutputNameOfInput">
+<code class="descname">getOutputNameOfInput</code><span class="sig-paren">(</span><em>inputBlock</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getOutputNameOfInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getOutputNameOfInput" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the name of the output port in the <code class="code docutils literal notranslate"><span class="pre">inputBlock</span></code> that is linked to this block.</p>
+<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">Parameters:</th><td class="field-body"><strong>inputBlock</strong> (<a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><em>BaseBlock</em></a>) – The block of which the output port must be obtained.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getInputName">
+<code class="descname">getInputName</code><span class="sig-paren">(</span><em>inputBlock</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getInputName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getInputName" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the names of the inputs that are linked to the <code class="code docutils literal notranslate"><span class="pre">inputBlock</span></code>.</p>
+<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">Parameters:</th><td class="field-body"><strong>inputBlock</strong> (<a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><em>BaseBlock</em></a>) – The block that is linked.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getClock">
+<code class="descname">getClock</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getClock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getClock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the simulation clock. Only works if the block is part of a <a class="reference internal" href="CBD.html#module-CBD" title="CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD</span></code></a> model.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.appendToSignal">
+<code class="descname">appendToSignal</code><span class="sig-paren">(</span><em>value</em>, <em>name_output=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.appendToSignal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.appendToSignal" title="Permalink to this definition">¶</a></dt>
+<dd><p>Appends the value to the set of obtained signals and links it to the current simulation
+time.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>value</strong> (<em>Any</em>) – The value to append.</li>
+<li><strong>name_output</strong> (<em>str</em>) – The name of the output port. If not set, or <code class="code docutils literal notranslate"><span class="pre">None</span></code>,
+the value of <code class="code docutils literal notranslate"><span class="pre">OUT1</span></code> will be used.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getSignal">
+<code class="descname">getSignal</code><span class="sig-paren">(</span><em>name_output=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getSignal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getSignal" title="Permalink to this definition">¶</a></dt>
+<dd><p>Obtains the set of signals this block has sent over an output port.</p>
+<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">Parameters:</th><td class="field-body"><strong>name_output</strong> (<em>str</em>) – The name of the output port. If not set, or <code class="code docutils literal notranslate"><span class="pre">None</span></code>,
+the value of <code class="code docutils literal notranslate"><span class="pre">OUT1</span></code> will be used.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getDependencies">
+<code class="descname">getDependencies</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getDependencies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getDependencies" title="Permalink to this definition">¶</a></dt>
+<dd><p>Helper function to help the creation of the dependency graph.</p>
+<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">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The current simulation’s iteration, for which
+the dependency graph must be constructed.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getBlockConnectedToInput">
+<code class="descname">getBlockConnectedToInput</code><span class="sig-paren">(</span><em>input_port</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getBlockConnectedToInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getBlockConnectedToInput" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the block that is connected to a specific input.</p>
+<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">Parameters:</th><td class="field-body"><strong>input_port</strong> (<em>str</em>) – The name of the input port.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getInputSignal">
+<code class="descname">getInputSignal</code><span class="sig-paren">(</span><em>curIteration</em>, <em>input_port=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getInputSignal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getInputSignal" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the signal sent out by the input block.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>curIteration</strong> (<em>int</em>) – The iteration at which the signal is obtained.
+When <code class="code docutils literal notranslate"><span class="pre">None</span></code> or <code class="code docutils literal notranslate"><span class="pre">-1</span></code>, the last value
+will be used.</li>
+<li><strong>input_port</strong> (<em>str</em>) – The name of the input port. If omitted, or when
+<code class="code docutils literal notranslate"><span class="pre">None</span></code>, the value of <code class="code docutils literal notranslate"><span class="pre">IN1</span></code> will be used.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.getPath">
+<code class="descname">getPath</code><span class="sig-paren">(</span><em>sep='.'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.getPath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.getPath" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the path of the current block.
+This includes the paths from its parents. When the block has no parents
+i.e. when it’s the top-level block, the block’s name is returned.</p>
+<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">Parameters:</th><td class="field-body"><strong>sep</strong> (<em>str</em>) – The separator to use. Defaults to <code class="code docutils literal notranslate"><span class="pre">.</span></code></td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The full path as a string.</td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Examples</p>
+<p>A block called <code class="code docutils literal notranslate"><span class="pre">grandchild</span></code>, which is located in the <code class="code docutils literal notranslate"><span class="pre">child</span></code> CBD,
+that in its turn is located in this CBD has a path of <code class="code docutils literal notranslate"><span class="pre">child.grandchild</span></code>.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computes this block’s operation, based on its inputs and store it as an output
+signal.</p>
+<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">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.BaseBlock.linkInput">
+<code class="descname">linkInput</code><span class="sig-paren">(</span><em>in_block</em>, <em>name_input=None</em>, <em>name_output='OUT1'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#BaseBlock.linkInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.BaseBlock.linkInput" title="Permalink to this definition">¶</a></dt>
+<dd><p>Links the output of the <code class="code docutils literal notranslate"><span class="pre">from_block</span></code> to the input of the <code class="code docutils literal notranslate"><span class="pre">to_block</span></code>.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>in_block</strong> (<a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><em>BaseBlock</em></a>) – The block that must be linked.</li>
+<li><strong>name_input</strong> (<em>str</em>) – The name of the input port. When <code class="code docutils literal notranslate"><span class="pre">None</span></code> or omitted,
+the next input port is used. E.g. if the last port was
+<code class="code docutils literal notranslate"><span class="pre">IN1</span></code>, the input is assumed to be <code class="code docutils literal notranslate"><span class="pre">IN2</span></code>.</li>
+<li><strong>name_output</strong> (<em>str</em>) – The name of the output port. Defaults to <code class="code docutils literal notranslate"><span class="pre">OUT1</span></code>.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.CBD.InputPortBlock">
+<em class="property">class </em><code class="descclassname">CBD.CBD.</code><code class="descname">InputPortBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#InputPortBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.InputPortBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The input port of a CBD</p>
+<dl class="method">
+<dt id="CBD.CBD.InputPortBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#InputPortBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.InputPortBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computes this block’s operation, based on its inputs and store it as an output
+signal.</p>
+<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">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.CBD.OutputPortBlock">
+<em class="property">class </em><code class="descclassname">CBD.CBD.</code><code class="descname">OutputPortBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#OutputPortBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.OutputPortBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The output port of a CBD</p>
+<dl class="method">
+<dt id="CBD.CBD.OutputPortBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#OutputPortBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.OutputPortBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computes this block’s operation, based on its inputs and store it as an output
+signal.</p>
+<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">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.CBD.WireBlock">
+<em class="property">class </em><code class="descclassname">CBD.CBD.</code><code class="descname">WireBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#WireBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.WireBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>When a CBD gets flattened, the port blocks will be replaced by a wire block</p>
+<dl class="method">
+<dt id="CBD.CBD.WireBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#WireBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.WireBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computes this block’s operation, based on its inputs and store it as an output
+signal.</p>
+<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">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.CBD.SequenceBlock">
+<em class="property">class </em><code class="descclassname">CBD.CBD.</code><code class="descname">SequenceBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>sequence</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#SequenceBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.SequenceBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A simple Sequence block: block initializes signal input with given sequence
+Use only for the tests please</p>
+<dl class="method">
+<dt id="CBD.CBD.SequenceBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#SequenceBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.SequenceBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computes this block’s operation, based on its inputs and store it as an output
+signal.</p>
+<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">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.CBD.CBD">
+<em class="property">class </em><code class="descclassname">CBD.CBD.</code><code class="descname">CBD</code><span class="sig-paren">(</span><em>block_name</em>, <em>input_ports=None</em>, <em>output_ports=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The CBD class, contains an entire Causal Block Diagram
+Call the run function to simulate the model.</p>
+<dl class="method">
+<dt id="CBD.CBD.CBD.getTopCBD">
+<code class="descname">getTopCBD</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.getTopCBD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.getTopCBD" title="Permalink to this definition">¶</a></dt>
+<dd><p>Finds the highest-level <a class="reference internal" href="CBD.html#module-CBD" title="CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD</span></code></a> instance.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.flatten">
+<code class="descname">flatten</code><span class="sig-paren">(</span><em>parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.flatten"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.flatten" title="Permalink to this definition">¶</a></dt>
+<dd><p>Flatten the CBD parent and call flatten recursively for CBD’s in this CBD</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.getBlocks">
+<code class="descname">getBlocks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.getBlocks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.getBlocks" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the list of blocks.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.getBlockByName">
+<code class="descname">getBlockByName</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.getBlockByName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.getBlockByName" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets a block by its name.</p>
+<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">Parameters:</th><td class="field-body"><strong>name</strong> (<em>str</em>) – The block’s name</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.getClock">
+<code class="descname">getClock</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.getClock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.getClock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the current simulation clock.
+This will always be the block of the highest-level <a class="reference internal" href="CBD.html#module-CBD" title="CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD</span></code></a>.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.setClock">
+<code class="descname">setClock</code><span class="sig-paren">(</span><em>clock</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.setClock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.setClock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the clock of the highest-level <a class="reference internal" href="CBD.html#module-CBD" title="CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD</span></code></a>.</p>
+<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">Parameters:</th><td class="field-body"><strong>clock</strong> (<a class="reference internal" href="CBD.simulator.html#CBD.simulator.Clock" title="CBD.simulator.Clock"><em>Clock</em></a>) – The clock to set.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.addBlock">
+<code class="descname">addBlock</code><span class="sig-paren">(</span><em>block</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.addBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.addBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add a block to the CBD model</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.removeBlock">
+<code class="descname">removeBlock</code><span class="sig-paren">(</span><em>block</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.removeBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.removeBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Removes a block from the <a class="reference internal" href="CBD.html#module-CBD" title="CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD</span></code></a>.</p>
+<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">Parameters:</th><td class="field-body"><strong>block</strong> (<a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><em>BaseBlock</em></a>) – The block to remove.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.addConnection">
+<code class="descname">addConnection</code><span class="sig-paren">(</span><em>from_block</em>, <em>to_block</em>, <em>input_port_name=None</em>, <em>output_port_name=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.addConnection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.addConnection" title="Permalink to this definition">¶</a></dt>
+<dd><p>Adds a connection between <code class="code docutils literal notranslate"><span class="pre">from_block</span></code> with <code class="code docutils literal notranslate"><span class="pre">input_port_name</span></code> to
+<code class="code docutils literal notranslate"><span class="pre">to_block</span></code> with <code class="code docutils literal notranslate"><span class="pre">outport_port_name</span></code>.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>from_block</strong> (<a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><em>BaseBlock</em></a>) – The block to start the connection from.</li>
+<li><strong>to_block</strong> (<a class="reference internal" href="#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><em>BaseBlock</em></a>) – The target block of the connection.</li>
+<li><strong>input_port_name</strong> (<em>str</em>) – The name of the input port. When <code class="code docutils literal notranslate"><span class="pre">None</span></code> or unset,
+the next port is used. E.g. when called after <code class="code docutils literal notranslate"><span class="pre">IN1</span></code>
+is already set, <code class="code docutils literal notranslate"><span class="pre">IN2</span></code> will be used.</li>
+<li><strong>output_port_name</strong> (<em>str</em>) – The name of the output port. When not set or <code class="code docutils literal notranslate"><span class="pre">None</span></code>,
+<code class="code docutils literal notranslate"><span class="pre">OUT1</span></code> will be used.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<p class="last"><a class="reference internal" href="#CBD.CBD.BaseBlock.linkInput" title="CBD.CBD.BaseBlock.linkInput"><code class="xref py py-func docutils literal notranslate"><span class="pre">BaseBlock.linkInput()</span></code></a></p>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.findBlock">
+<code class="descname">findBlock</code><span class="sig-paren">(</span><em>path</em>, <em>sep='.'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.findBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.findBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Obtain a block in a submodel of this CBD.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>path</strong> (<em>str</em>) – The path of the block to find. Empty string for the current block,
+<code class="code docutils literal notranslate"><span class="pre">child.grandchild</span></code> for the block called code:<cite>grandchild</cite>,
+which is located in the <code class="code docutils literal notranslate"><span class="pre">child</span></code> CBD that is located in this CBD.</li>
+<li><strong>sep</strong> (<em>str</em>) – The path separator to use. Defaults to <code class="code docutils literal notranslate"><span class="pre">.</span></code></li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><p>The block that corresponds to the given path.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The block that will be returned has a different path than the path provided
+in this function call. This is because this function assumes you already have
+a path to the CBD you call it on. For instance, if this CBD contains a child
+called <code class="code docutils literal notranslate"><span class="pre">child</span></code>, which has a <code class="code docutils literal notranslate"><span class="pre">grandchild</span></code> block in its turn, calling
+findBlock on the <code class="xref py py-class docutils literal notranslate"><span class="pre">child</span></code> to locate the <code class="code docutils literal notranslate"><span class="pre">grandchild</span></code> only needs
+<code class="code docutils literal notranslate"><span class="pre">grandchild</span></code> to be passed as a path. If the function is called on the
+current CBD block instead, <code class="code docutils literal notranslate"><span class="pre">child.grandchild</span></code> is required to obtain the
+same block.</p>
+</div>
+</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.dump">
+<code class="descname">dump</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.dump"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.dump" title="Permalink to this definition">¶</a></dt>
+<dd><p>Dumps the model information to the console.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.dumpSignals">
+<code class="descname">dumpSignals</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.dumpSignals"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.dumpSignals" title="Permalink to this definition">¶</a></dt>
+<dd><p>Dumps the signal inromation to the console.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.getSignal">
+<code class="descname">getSignal</code><span class="sig-paren">(</span><em>name_output=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.getSignal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.getSignal" title="Permalink to this definition">¶</a></dt>
+<dd><p>Obtains the set of signals this block has sent over an output port.</p>
+<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">Parameters:</th><td class="field-body"><strong>name_output</strong> (<em>str</em>) – The name of the output port. If not set, or <code class="code docutils literal notranslate"><span class="pre">None</span></code>,
+the value of <code class="code docutils literal notranslate"><span class="pre">OUT1</span></code> will be used.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.CBD.CBD.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD.html#CBD.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD.CBD.compute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computes this block’s operation, based on its inputs and store it as an output
+signal.</p>
+<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">Parameters:</th><td class="field-body"><strong>curIteration</strong> (<em>int</em>) – The iteration at which we must compute this value.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.CBD2LaTeX.html" class="btn btn-neutral float-right" title="CBD.CBD2LaTeX module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.realtime.threadingTkInter.html" class="btn btn-neutral" title="CBD.realtime.threadingTkInter module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.CBD module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.CBD2LaTeX.html

@@ -0,0 +1,451 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.CBD2LaTeX module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.CBDDraw module" href="CBD.CBDDraw.html" />
+    <link rel="prev" title="CBD.CBD module" href="CBD.CBD.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.CBD2LaTeX module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.CBD2LaTeX">
+<span id="cbd-cbd2latex-module"></span><h1>CBD.CBD2LaTeX module<a class="headerlink" href="#module-CBD.CBD2LaTeX" title="Permalink to this headline">¶</a></h1>
+<p>The LaTeX generator for a given CBD model.</p>
+<p>All basic building blocks (from <a class="reference internal" href="CBD.lib.std.html#module-CBD.lib.std" title="CBD.lib.std"><code class="xref py py-mod docutils literal notranslate"><span class="pre">CBD.lib.std</span></code></a>) have a
+pre-defined latex representation. If this needs to be overwritten,
+a <code class="xref py py-func docutils literal notranslate"><span class="pre">latex()</span></code> member function can be added to all blocks to
+overwrite the given representation. Blocks for which no LaTeX is
+defined will be ignored in the generation.</p>
+<dl class="function">
+<dt id="CBD.CBD2LaTeX.latexify">
+<code class="descclassname">CBD.CBD2LaTeX.</code><code class="descname">latexify</code><span class="sig-paren">(</span><em>cbd</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBD2LaTeX.html#latexify"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBD2LaTeX.latexify" title="Permalink to this definition">¶</a></dt>
+<dd><p>Does the actual conversion of a <a class="reference internal" href="CBD.html#module-CBD" title="CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD</span></code></a>.</p>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">This does not work for <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseBlock</span></code> instances.</p>
+</div>
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.CBDDraw.html" class="btn btn-neutral float-right" title="CBD.CBDDraw module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.CBD.html" class="btn btn-neutral" title="CBD.CBD module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.CBD2LaTeX module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.CBDDraw.html

@@ -0,0 +1,454 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.CBDDraw module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.depGraph module" href="CBD.depGraph.html" />
+    <link rel="prev" title="CBD.CBD2LaTeX module" href="CBD.CBD2LaTeX.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.CBDDraw module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.CBDDraw">
+<span id="cbd-cbddraw-module"></span><h1>CBD.CBDDraw module<a class="headerlink" href="#module-CBD.CBDDraw" title="Permalink to this headline">¶</a></h1>
+<dl class="function">
+<dt id="CBD.CBDDraw.draw">
+<code class="descclassname">CBD.CBDDraw.</code><code class="descname">draw</code><span class="sig-paren">(</span><em>cbd</em>, <em>filename</em>, <em>colors=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/CBDDraw.html#draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.CBDDraw.draw" title="Permalink to this definition">¶</a></dt>
+<dd><p>Output <a class="reference internal" href="CBD.html#module-CBD" title="CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD</span></code></a> as a graphviz script to filename.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>cbd</strong> (<a class="reference internal" href="CBD.CBD.html#CBD.CBD.CBD" title="CBD.CBD.CBD"><em>CBD</em></a>) – The <a class="reference internal" href="CBD.html#module-CBD" title="CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD</span></code></a> to draw.</li>
+<li><strong>filename</strong> (<em>str</em>) – The name of the dot-file.</li>
+<li><strong>colors</strong> (<em>dict</em>) – An optional dictionary of blockname =&gt; color.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.depGraph.html" class="btn btn-neutral float-right" title="CBD.depGraph module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.CBD2LaTeX.html" class="btn btn-neutral" title="CBD.CBD2LaTeX module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.CBDDraw module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.Source.CBD.html

@@ -1,109 +0,0 @@
-
-<!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="X-UA-Compatible" content="IE=Edge" />
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>CBD.Source.CBD module &#8212; CBD Simulation Development Kit  documentation</title>
-    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" type="text/css" href="_static/style.css" />
-    
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
-    <script type="text/javascript" src="_static/language_data.js"></script>
-    <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>
-    
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="CBD.Source.CBDDraw module" href="CBD.Source.CBDDraw.html" />
-    <link rel="prev" title="CBD.Source package" href="CBD.Source.html" /> 
-  </head><body>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.CBDDraw.html" title="CBD.Source.CBDDraw module"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.html" title="CBD.Source package"
-             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="CBD.Source.html" accesskey="U">CBD.Source package</a> &#187;</li> 
-      </ul>
-    </div>  
-
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
-            
-  <div class="section" id="cbd-source-cbd-module">
-<h1>CBD.Source.CBD module<a class="headerlink" href="#cbd-source-cbd-module" title="Permalink to this headline">¶</a></h1>
-</div>
-
-
-          </div>
-        </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="CBD.Source.html"
-                        title="previous chapter">CBD.Source package</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="CBD.Source.CBDDraw.html"
-                        title="next chapter">CBD.Source.CBDDraw module</a></p>
-<div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
-    <div class="searchformwrapper">
-    <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>
-    </div>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
-        </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.CBDDraw.html" title="CBD.Source.CBDDraw module"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.html" title="CBD.Source package"
-             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="CBD.Source.html" >CBD.Source package</a> &#187;</li> 
-      </ul>
-    </div>
-    <div class="footer" role="contentinfo">
-        &#169; Copyright 2020, Randy Paredis.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
-    </div>
-  </body>
-</html>

doc/_build/html/CBD.Source.CBDDraw.html

@@ -1,109 +0,0 @@
-
-<!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="X-UA-Compatible" content="IE=Edge" />
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>CBD.Source.CBDDraw module &#8212; CBD Simulation Development Kit  documentation</title>
-    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" type="text/css" href="_static/style.css" />
-    
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
-    <script type="text/javascript" src="_static/language_data.js"></script>
-    <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>
-    
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="CBD.Source.naivelog module" href="CBD.Source.naivelog.html" />
-    <link rel="prev" title="CBD.Source.CBD module" href="CBD.Source.CBD.html" /> 
-  </head><body>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.naivelog.html" title="CBD.Source.naivelog module"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.CBD.html" title="CBD.Source.CBD module"
-             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="CBD.Source.html" accesskey="U">CBD.Source package</a> &#187;</li> 
-      </ul>
-    </div>  
-
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
-            
-  <div class="section" id="cbd-source-cbddraw-module">
-<h1>CBD.Source.CBDDraw module<a class="headerlink" href="#cbd-source-cbddraw-module" title="Permalink to this headline">¶</a></h1>
-</div>
-
-
-          </div>
-        </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="CBD.Source.CBD.html"
-                        title="previous chapter">CBD.Source.CBD module</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="CBD.Source.naivelog.html"
-                        title="next chapter">CBD.Source.naivelog module</a></p>
-<div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
-    <div class="searchformwrapper">
-    <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>
-    </div>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
-        </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.naivelog.html" title="CBD.Source.naivelog module"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.CBD.html" title="CBD.Source.CBD module"
-             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="CBD.Source.html" >CBD.Source package</a> &#187;</li> 
-      </ul>
-    </div>
-    <div class="footer" role="contentinfo">
-        &#169; Copyright 2020, Randy Paredis.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
-    </div>
-  </body>
-</html>

doc/_build/html/CBD.Source.html

@@ -1,125 +0,0 @@
-
-<!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="X-UA-Compatible" content="IE=Edge" />
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>CBD.Source package &#8212; CBD Simulation Development Kit  documentation</title>
-    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" type="text/css" href="_static/style.css" />
-    
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
-    <script type="text/javascript" src="_static/language_data.js"></script>
-    <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>
-    
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="CBD.Source.CBD module" href="CBD.Source.CBD.html" />
-    <link rel="prev" title="CBD package" href="CBD.html" /> 
-  </head><body>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.CBD.html" title="CBD.Source.CBD module"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="CBD.html" title="CBD package"
-             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" accesskey="U">CBD package</a> &#187;</li> 
-      </ul>
-    </div>  
-
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
-            
-  <div class="section" id="cbd-source-package">
-<h1>CBD.Source package<a class="headerlink" href="#cbd-source-package" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="submodules">
-<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
-<div class="toctree-wrapper compound">
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="CBD.Source.CBD.html">CBD.Source.CBD module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="CBD.Source.CBDDraw.html">CBD.Source.CBDDraw module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="CBD.Source.naivelog.html">CBD.Source.naivelog module</a></li>
-</ul>
-</div>
-</div>
-</div>
-
-
-          </div>
-        </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-  <h3><a href="index.html">Table of Contents</a></h3>
-  <ul>
-<li><a class="reference internal" href="#">CBD.Source package</a><ul>
-<li><a class="reference internal" href="#submodules">Submodules</a></li>
-</ul>
-</li>
-</ul>
-
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="CBD.html"
-                        title="previous chapter">CBD package</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="CBD.Source.CBD.html"
-                        title="next chapter">CBD.Source.CBD module</a></p>
-<div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
-    <div class="searchformwrapper">
-    <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>
-    </div>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
-        </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.CBD.html" title="CBD.Source.CBD module"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="CBD.html" title="CBD package"
-             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li> 
-      </ul>
-    </div>
-    <div class="footer" role="contentinfo">
-        &#169; Copyright 2020, Randy Paredis.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
-    </div>
-  </body>
-</html>

doc/_build/html/CBD.Source.naivelog.html

@@ -1,109 +0,0 @@
-
-<!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="X-UA-Compatible" content="IE=Edge" />
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>CBD.Source.naivelog module &#8212; CBD Simulation Development Kit  documentation</title>
-    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" type="text/css" href="_static/style.css" />
-    
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
-    <script type="text/javascript" src="_static/language_data.js"></script>
-    <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>
-    
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Converting Draw.io to CBD" href="drawio2cbd.html" />
-    <link rel="prev" title="CBD.Source.CBDDraw module" href="CBD.Source.CBDDraw.html" /> 
-  </head><body>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="drawio2cbd.html" title="Converting Draw.io to CBD"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.CBDDraw.html" title="CBD.Source.CBDDraw module"
-             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="CBD.Source.html" accesskey="U">CBD.Source package</a> &#187;</li> 
-      </ul>
-    </div>  
-
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
-            
-  <div class="section" id="cbd-source-naivelog-module">
-<h1>CBD.Source.naivelog module<a class="headerlink" href="#cbd-source-naivelog-module" title="Permalink to this headline">¶</a></h1>
-</div>
-
-
-          </div>
-        </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="CBD.Source.CBDDraw.html"
-                        title="previous chapter">CBD.Source.CBDDraw module</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="drawio2cbd.html"
-                        title="next chapter">Converting Draw.io to CBD</a></p>
-<div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
-    <div class="searchformwrapper">
-    <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>
-    </div>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
-        </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="drawio2cbd.html" title="Converting Draw.io to CBD"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="CBD.Source.CBDDraw.html" title="CBD.Source.CBDDraw module"
-             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="CBD.Source.html" >CBD.Source package</a> &#187;</li> 
-      </ul>
-    </div>
-    <div class="footer" role="contentinfo">
-        &#169; Copyright 2020, Randy Paredis.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
-    </div>
-  </body>
-</html>

doc/_build/html/CBD.depGraph.html

@@ -0,0 +1,625 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.depGraph module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.naivelog module" href="CBD.naivelog.html" />
+    <link rel="prev" title="CBD.CBDDraw module" href="CBD.CBDDraw.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.depGraph module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.depGraph">
+<span id="cbd-depgraph-module"></span><h1>CBD.depGraph module<a class="headerlink" href="#module-CBD.depGraph" title="Permalink to this headline">¶</a></h1>
+<p>This module implements a dependency graph</p>
+<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">Author:</th><td class="field-body">Marc Provost</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Organization:</th><td class="field-body">McGill University</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">License:</th><td class="field-body">GNU General Public License</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Contact:</th><td class="field-body"><a class="reference external" href="mailto:marc&#46;provost&#37;&#52;&#48;mail&#46;mcgill&#46;ca">marc<span>&#46;</span>provost<span>&#64;</span>mail<span>&#46;</span>mcgill<span>&#46;</span>ca</a></td>
+</tr>
+</tbody>
+</table>
+<dl class="class">
+<dt id="CBD.depGraph.DepNode">
+<em class="property">class </em><code class="descclassname">CBD.depGraph.</code><code class="descname">DepNode</code><span class="sig-paren">(</span><em>object</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepNode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepNode" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Class implementing a node in the dependency graph.</p>
+<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">Parameters:</th><td class="field-body"><strong>object</strong> – Reference to a semantic object identifying the node</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
+<dt id="CBD.depGraph.DepNode.mark">
+<code class="descname">mark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepNode.mark"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepNode.mark" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepNode.unMark">
+<code class="descname">unMark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepNode.unMark"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepNode.unMark" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepNode.isMarked">
+<code class="descname">isMarked</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepNode.isMarked"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepNode.isMarked" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepNode.getMappedObj">
+<code class="descname">getMappedObj</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepNode.getMappedObj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepNode.getMappedObj" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.depGraph.DepGraph">
+<em class="property">class </em><code class="descclassname">CBD.depGraph.</code><code class="descname">DepGraph</code><a class="reference internal" href="_modules/CBD/depGraph.html#DepGraph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepGraph" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Class implementing dependency graph.</p>
+<dl class="method">
+<dt id="CBD.depGraph.DepGraph.addMember">
+<code class="descname">addMember</code><span class="sig-paren">(</span><em>object</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepGraph.addMember"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepGraph.addMember" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add an object mapped to this graph.</p>
+<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">Parameters:</th><td class="field-body"><strong>object</strong> – the object to be added</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If object is already in the graph</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepGraph.hasMember">
+<code class="descname">hasMember</code><span class="sig-paren">(</span><em>object</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepGraph.hasMember"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepGraph.hasMember" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepGraph.removeMember">
+<code class="descname">removeMember</code><span class="sig-paren">(</span><em>object</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepGraph.removeMember"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepGraph.removeMember" title="Permalink to this definition">¶</a></dt>
+<dd><p>Remove a object from this graph.</p>
+<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">Parameters:</th><td class="field-body"><strong>object</strong> – the object to be removed</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – If object is not in the graph</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepGraph.setDependency">
+<code class="descname">setDependency</code><span class="sig-paren">(</span><em>dependent</em>, <em>influencer</em>, <em>curIt</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepGraph.setDependency"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepGraph.setDependency" title="Permalink to this definition">¶</a></dt>
+<dd><p>Creates a dependency between two objects.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>dependent</strong> – The object which depends on the other</li>
+<li><strong>influencer</strong> – The object which influences the other</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
+<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – if depedent or influencer is not member of this graph</li>
+<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – if the dependency already exists</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepGraph.hasDependency">
+<code class="descname">hasDependency</code><span class="sig-paren">(</span><em>dependent</em>, <em>influencer</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepGraph.hasDependency"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepGraph.hasDependency" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepGraph.unsetDependency">
+<code class="descname">unsetDependency</code><span class="sig-paren">(</span><em>dependent</em>, <em>influencer</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepGraph.unsetDependency"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepGraph.unsetDependency" title="Permalink to this definition">¶</a></dt>
+<dd><p>Removes a dependency between two objects.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>dependent</strong> – The object which depends on the other</li>
+<li><strong>influencer</strong> – The object which influences the other</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
+<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – if depedent or influencer is not member of this graph</li>
+<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – if the dependency does not exists</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepGraph.getDependents">
+<code class="descname">getDependents</code><span class="sig-paren">(</span><em>object</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepGraph.getDependents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepGraph.getDependents" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepGraph.getInfluencers">
+<code class="descname">getInfluencers</code><span class="sig-paren">(</span><em>object</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepGraph.getInfluencers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepGraph.getInfluencers" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.depGraph.DepGraph.getStrongComponents">
+<code class="descname">getStrongComponents</code><span class="sig-paren">(</span><em>curIt=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#DepGraph.getStrongComponents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.DepGraph.getStrongComponents" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="CBD.depGraph.createDepGraph">
+<code class="descclassname">CBD.depGraph.</code><code class="descname">createDepGraph</code><span class="sig-paren">(</span><em>model</em>, <em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#createDepGraph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.createDepGraph" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a dependency graph of the CBD model.
+Use the curIteration to differentiate between the first and other iterations
+Watch out for dependencies with sub-models.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="CBD.depGraph.gvDepGraph">
+<code class="descclassname">CBD.depGraph.</code><code class="descname">gvDepGraph</code><span class="sig-paren">(</span><em>model</em>, <em>curIt</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/depGraph.html#gvDepGraph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.depGraph.gvDepGraph" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a Graphviz string that corresponds to the dependency graph
+at the given iteration cycle.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>model</strong> (<a class="reference internal" href="CBD.CBD.html#CBD.CBD.CBD" title="CBD.CBD.CBD"><em>CBD</em></a>) – The <a class="reference internal" href="CBD.html#module-CBD" title="CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD</span></code></a> model to construct the graph for.</li>
+<li><strong>curIt</strong> (<em>int</em>) – The iteration for which the dependency graph will
+be constructed.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.naivelog.html" class="btn btn-neutral float-right" title="CBD.naivelog module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.CBDDraw.html" class="btn btn-neutral" title="CBD.CBDDraw module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.depGraph module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.html

@@ -1,195 +1,488 @@
 
-<!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="X-UA-Compatible" content="IE=Edge" />
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>CBD package &#8212; CBD Simulation Development Kit  documentation</title>
-    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" type="text/css" href="_static/style.css" />
-    
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
-    <script type="text/javascript" src="_static/language_data.js"></script>
-    <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>
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD package &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
     
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="CBD.src package" href="CBD.src.html" />
+    <link rel="next" title="CBD.lib package" href="CBD.lib.html" />
     <link rel="prev" title="Welcome to the CBD Development Kit’s Documentation!" href="index.html" /> 
-  </head><body>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.src.html" title="CBD.src package"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="index.html" title="Welcome to the CBD Development Kit’s Documentation!"
-             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li> 
-      </ul>
-    </div>  
-
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
             
-  <div class="section" id="cbd-package">
-<h1>CBD package<a class="headerlink" href="#cbd-package" title="Permalink to this headline">¶</a></h1>
-<p>Python-based framework for CBD modeling and simulation.</p>
-<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>Marc Provost</li>
-<li>Hans Vangheluwe</li>
-<li>Joachim Denil</li>
-<li>Claudio Gomes</li>
-<li>Randy Paredis</li>
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="#">CBD package</a></li>
 </ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Python Version:</th><td class="field-body"><p class="first last">&gt;= 3.6</p>
-</td>
-</tr>
-</tbody>
-</table>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+      <li>CBD package</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD">
+<span id="cbd-package"></span><h1>CBD package<a class="headerlink" href="#module-CBD" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="CBD.src.html">CBD.src package</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="CBD.src.html#submodules">Submodules</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="CBD.src.CBD.html">CBD.src.CBD module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="CBD.src.CBDDraw.html">CBD.src.CBDDraw module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="CBD.src.naivelog.html">CBD.src.naivelog module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.lib.html">CBD.lib package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="CBD.lib.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="CBD.lib.interface.html">CBD.lib.interface package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="CBD.lib.interface.html#submodules">Submodules</a><ul>
+<li class="toctree-l5"><a class="reference internal" href="CBD.lib.interface.endpoints.html">CBD.lib.interface.endpoints module</a></li>
+<li class="toctree-l5"><a class="reference internal" href="CBD.lib.interface.plotting.html">CBD.lib.interface.plotting module</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
-</div>
-<div class="section" id="prerequisites">
-<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
-<p>The following packages are required to run simulations using this framework:</p>
-<ul>
-<li><p class="first"><em>Standard Python Modules:</em> <code class="code docutils literal notranslate"><span class="pre">unittest</span></code>, <code class="code docutils literal notranslate"><span class="pre">math</span></code>, <code class="code docutils literal notranslate"><span class="pre">collections</span></code> (for <code class="code docutils literal notranslate"><span class="pre">collections.namedtuple</span></code>),
-<code class="code docutils literal notranslate"><span class="pre">os</span></code>, <code class="code docutils literal notranslate"><span class="pre">sys</span></code>, <code class="code docutils literal notranslate"><span class="pre">datetime</span></code>, <span class="math notranslate nohighlight">\(re\)</span></p>
 </li>
-<li><p class="first"><a class="reference external" href="https://bokeh.org">bokeh</a> for plotting. To install bokeh for python, follow
-<a class="reference external" href="https://bokeh.pydata.org/en/latest/docs/user_guide/quickstart.html#installation">these instructions</a>.</p>
+<li class="toctree-l2"><a class="reference internal" href="CBD.lib.html#submodules">Submodules</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="CBD.lib.std.html">CBD.lib.std module</a></li>
+</ul>
 </li>
-<li><p class="first"><a class="reference external" href="http://graphviz.org/">GraphViz</a> to display the dependency structure of the CBD. To install Graphviz,
-follow these steps:</p>
-<ol class="arabic simple">
-<li>Download and install Graphviz: <a class="reference external" href="https://www.graphviz.org/download/">https://www.graphviz.org/download/</a></li>
-<li>Make sure the Graphviz binaries are accessible in the PATH environment variable.
-For example, on windows there should be an entry in the PATH with: <code class="file docutils literal notranslate"><span class="pre">C:\Graphviz2.38\bin</span></code></li>
-<li>Install <code class="code docutils literal notranslate"><span class="pre">graphviz</span></code> for Python: <a class="reference external" href="https://graphviz.readthedocs.io/en/stable/manual.html">https://graphviz.readthedocs.io/en/stable/manual.html</a></li>
-</ol>
-<blockquote>
-<div><div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">For anaconda users, use <a class="reference external" href="https://anaconda.org/anaconda/graphviz">https://anaconda.org/anaconda/graphviz</a></p>
-</div>
-</div></blockquote>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.realtime.html">CBD.realtime package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="CBD.realtime.html#submodules">Submodules</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="CBD.realtime.plotting.html">CBD.realtime.plotting module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="CBD.realtime.threadingBackend.html">CBD.realtime.threadingBackend module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="CBD.realtime.threadingGameLoop.html">CBD.realtime.threadingGameLoop module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="CBD.realtime.threadingPython.html">CBD.realtime.threadingPython module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="CBD.realtime.threadingTkInter.html">CBD.realtime.threadingTkInter module</a></li>
+</ul>
+</li>
+</ul>
 </li>
 </ul>
 </div>
-<div class="section" id="running-the-tests">
-<h2>Running the Tests<a class="headerlink" href="#running-the-tests" title="Permalink to this headline">¶</a></h2>
-<p>From the root directory of the CBD Simulator Framework (i.e., where this README file resides), execute:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3 -m unittest discover -v CBD.test <span class="s2">&quot;*.py&quot;</span>
-</pre></div>
-</div>
-<p><code class="code docutils literal notranslate"><span class="pre">testDerivatorBlock</span></code> and <code class="code docutils literal notranslate"><span class="pre">testIntegratorBlock</span></code> will fail while working on the Discrete-Time CBD simulator.</p>
-</div>
-<div class="section" id="running-examples">
-<h2>Running Examples<a class="headerlink" href="#running-examples" title="Permalink to this headline">¶</a></h2>
-<p>Make sure that PYTHONPATH includes the root directory of the CBD Simulator Framework.</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> examples/EvenNumberGen/
-python3 EvenNumberGen.py
-</pre></div>
 </div>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> examples/Fibonacci/
-python3 Fibonacci.py
-</pre></div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CBD.CBD.html">CBD.CBD module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.CBD2LaTeX.html">CBD.CBD2LaTeX module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.CBDDraw.html">CBD.CBDDraw module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.depGraph.html">CBD.depGraph module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.naivelog.html">CBD.naivelog module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.simulator.html">CBD.simulator module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.solver.html">CBD.solver module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.util.html">CBD.util module</a></li>
+</ul>
 </div>
-<p>Both will generate an HTML document containing a bokeh plot in the current directory.</p>
 </div>
 </div>
 
 
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.lib.html" class="btn btn-neutral float-right" title="CBD.lib package" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="index.html" class="btn btn-neutral" title="Welcome to the CBD Development Kit’s Documentation!" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
           </div>
         </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-  <h3><a href="index.html">Table of Contents</a></h3>
-  <ul>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
 <li><a class="reference internal" href="#">CBD package</a><ul>
-<li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
-<li><a class="reference internal" href="#running-the-tests">Running the Tests</a></li>
-<li><a class="reference internal" href="#running-examples">Running Examples</a></li>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
 </ul>
 </li>
 </ul>
 
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="index.html"
-                        title="previous chapter">Welcome to the CBD Development Kit’s Documentation!</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="CBD.src.html"
-                        title="next chapter">CBD.src package</a></p>
-<div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
-    <div class="searchformwrapper">
-    <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>
+            </div>
+          </div>
+        </div>
+      </section>
     </div>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
         </div>
       </div>
-      <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.src.html" title="CBD.src package"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="index.html" title="Welcome to the CBD Development Kit’s Documentation!"
-             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li> 
-      </ul>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
     </div>
-    <div class="footer" role="contentinfo">
-        &#169; Copyright 2020, Randy Paredis.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
     </div>
-  </body>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
 </html>

doc/_build/html/CBD.lib.html

@@ -0,0 +1,462 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.lib package &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.lib.interface package" href="CBD.lib.interface.html" />
+    <link rel="prev" title="CBD package" href="CBD.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.lib package</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.lib">
+<span id="cbd-lib-package"></span><h1>CBD.lib package<a class="headerlink" href="#module-CBD.lib" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CBD.lib.interface.html">CBD.lib.interface package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="CBD.lib.interface.html#submodules">Submodules</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="CBD.lib.interface.endpoints.html">CBD.lib.interface.endpoints module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="CBD.lib.interface.plotting.html">CBD.lib.interface.plotting module</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CBD.lib.std.html">CBD.lib.std module</a></li>
+</ul>
+</div>
+</div>
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.lib.interface.html" class="btn btn-neutral float-right" title="CBD.lib.interface package" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.html" class="btn btn-neutral" title="CBD package" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.lib package</a><ul>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+</ul>
+</li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.lib.interface.html

@@ -0,0 +1,449 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.lib.interface package &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.lib.interface.endpoints module" href="CBD.lib.interface.endpoints.html" />
+    <link rel="prev" title="CBD.lib package" href="CBD.lib.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+          <li><a href="CBD.lib.html">CBD.lib package</a> &gt;</li>
+        
+      <li>CBD.lib.interface package</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.lib.interface">
+<span id="cbd-lib-interface-package"></span><h1>CBD.lib.interface package<a class="headerlink" href="#module-CBD.lib.interface" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CBD.lib.interface.endpoints.html">CBD.lib.interface.endpoints module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.lib.interface.plotting.html">CBD.lib.interface.plotting module</a></li>
+</ul>
+</div>
+</div>
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.lib.interface.endpoints.html" class="btn btn-neutral float-right" title="CBD.lib.interface.endpoints module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.lib.html" class="btn btn-neutral" title="CBD.lib package" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.lib.interface package</a><ul>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+</ul>
+</li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.lib.std.html

@@ -0,0 +1,747 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.lib.std module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.realtime package" href="CBD.realtime.html" />
+    <link rel="prev" title="CBD.lib.interface.plotting module" href="CBD.lib.interface.plotting.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+          <li><a href="CBD.lib.html">CBD.lib package</a> &gt;</li>
+        
+      <li>CBD.lib.std module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.lib.std">
+<span id="cbd-lib-std-module"></span><h1>CBD.lib.std module<a class="headerlink" href="#module-CBD.lib.std" title="Permalink to this headline">¶</a></h1>
+<p>This file contains the standard library for CBD building blocks.</p>
+<dl class="class">
+<dt id="CBD.lib.std.ConstantBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">ConstantBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>value=0.0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ConstantBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ConstantBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The constant block will always output its constant value</p>
+<dl class="method">
+<dt id="CBD.lib.std.ConstantBlock.getValue">
+<code class="descname">getValue</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ConstantBlock.getValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ConstantBlock.getValue" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.lib.std.ConstantBlock.setValue">
+<code class="descname">setValue</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ConstantBlock.setValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ConstantBlock.setValue" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.lib.std.ConstantBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ConstantBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ConstantBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.NegatorBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">NegatorBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#NegatorBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.NegatorBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The negator block will output the value of the input multiplied with -1</p>
+<dl class="method">
+<dt id="CBD.lib.std.NegatorBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#NegatorBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.NegatorBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.InverterBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">InverterBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#InverterBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.InverterBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The invertblock will output 1/IN</p>
+<dl class="method">
+<dt id="CBD.lib.std.InverterBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#InverterBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.InverterBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.AdderBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">AdderBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AdderBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AdderBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The adderblock will add the 2 inputs</p>
+<dl class="method">
+<dt id="CBD.lib.std.AdderBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AdderBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AdderBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.ProductBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">ProductBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ProductBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ProductBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The product block will multiply the two inputs</p>
+<dl class="method">
+<dt id="CBD.lib.std.ProductBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ProductBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ProductBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.ModuloBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">ModuloBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ModuloBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ModuloBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A basic block that computes the IN1 modulo IN2</p>
+<dl class="method">
+<dt id="CBD.lib.std.ModuloBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ModuloBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ModuloBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.RootBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">RootBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#RootBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.RootBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A basic block that computes the IN2-th root from IN1</p>
+<dl class="method">
+<dt id="CBD.lib.std.RootBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#RootBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.RootBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.AbsBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">AbsBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AbsBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AbsBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The abs block will output the absolute value of the input.</p>
+<dl class="method">
+<dt id="CBD.lib.std.AbsBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AbsBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AbsBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.IntBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">IntBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#IntBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.IntBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The int block will output the integer value (floored) of the input.</p>
+<dl class="method">
+<dt id="CBD.lib.std.IntBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#IntBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.IntBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.ClampBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">ClampBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>min=-1</em>, <em>max=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ClampBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ClampBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The clamp block will clamp the input between min and max.</p>
+<dl class="method">
+<dt id="CBD.lib.std.ClampBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#ClampBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.ClampBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.GenericBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">GenericBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>block_operator=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#GenericBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.GenericBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The generic block will evaluate the operator on the input
+operator is the name (a string) of a Python function from the math library
+which will be called when the block is evaluated
+by default, initialized to None</p>
+<dl class="method">
+<dt id="CBD.lib.std.GenericBlock.getBlockOperator">
+<code class="descname">getBlockOperator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#GenericBlock.getBlockOperator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.GenericBlock.getBlockOperator" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.lib.std.GenericBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#GenericBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.GenericBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.MultiplexerBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">MultiplexerBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#MultiplexerBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.MultiplexerBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>The multiplexer block will output the signal from IN1 if select == 0; otherwise
+the signal from IN2 is outputted.</p>
+<dl class="method">
+<dt id="CBD.lib.std.MultiplexerBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#MultiplexerBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.MultiplexerBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.LessThanBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">LessThanBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LessThanBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LessThanBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A simple block that will test if the IN1 is smaller than IN2 (output == 1 if true else 0)</p>
+<dl class="method">
+<dt id="CBD.lib.std.LessThanBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LessThanBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LessThanBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.EqualsBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">EqualsBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#EqualsBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.EqualsBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A simple block that will test if the IN1 is equal to IN2 (output == 1 if true else 0)</p>
+<dl class="method">
+<dt id="CBD.lib.std.EqualsBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#EqualsBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.EqualsBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.LessThanOrEqualsBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">LessThanOrEqualsBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LessThanOrEqualsBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LessThanOrEqualsBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A simple block that will test if the IN1 is smaller than or equals to IN2 (output == 1 if true else 0)</p>
+<dl class="method">
+<dt id="CBD.lib.std.LessThanOrEqualsBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LessThanOrEqualsBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LessThanOrEqualsBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.NotBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">NotBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#NotBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.NotBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A simple Not block that will set a 0 to 1 and vice versa</p>
+<dl class="method">
+<dt id="CBD.lib.std.NotBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#NotBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.NotBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.OrBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">OrBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>numberOfInputs=2</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#OrBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.OrBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A simple Or block with possibly multiple inputlines</p>
+<dl class="method">
+<dt id="CBD.lib.std.OrBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#OrBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.OrBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.lib.std.OrBlock.getNumberOfInputs">
+<code class="descname">getNumberOfInputs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#OrBlock.getNumberOfInputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.OrBlock.getNumberOfInputs" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.AndBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">AndBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>numberOfInputs=2</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AndBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AndBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A simple And block with possibly multiple inputlines</p>
+<dl class="method">
+<dt id="CBD.lib.std.AndBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AndBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AndBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.lib.std.AndBlock.getNumberOfInputs">
+<code class="descname">getNumberOfInputs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AndBlock.getNumberOfInputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AndBlock.getNumberOfInputs" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.DelayBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">DelayBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#DelayBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.DelayBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A delay block that takes the last value from the list
+IC: Initial Condition</p>
+<dl class="method">
+<dt id="CBD.lib.std.DelayBlock.getDependencies">
+<code class="descname">getDependencies</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#DelayBlock.getDependencies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.DelayBlock.getDependencies" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.lib.std.DelayBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#DelayBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.DelayBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.TimeBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">TimeBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#TimeBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.TimeBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>Outputs the current time of the simulation</p>
+<dl class="method">
+<dt id="CBD.lib.std.TimeBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#TimeBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.TimeBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.LoggingBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">LoggingBlock</code><span class="sig-paren">(</span><em>block_name</em>, <em>string</em>, <em>lev=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LoggingBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LoggingBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.BaseBlock" title="CBD.CBD.BaseBlock"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.BaseBlock</span></code></a></p>
+<p>A simple Logging block</p>
+<dl class="method">
+<dt id="CBD.lib.std.LoggingBlock.compute">
+<code class="descname">compute</code><span class="sig-paren">(</span><em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#LoggingBlock.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.LoggingBlock.compute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.AddOneBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">AddOneBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#AddOneBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.AddOneBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.CBD" title="CBD.CBD.CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.CBD</span></code></a></p>
+<p>Block adds a one to the input (used a lot for mux)</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.DerivatorBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">DerivatorBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#DerivatorBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.DerivatorBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.CBD" title="CBD.CBD.CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.CBD</span></code></a></p>
+<p>The derivator block is a CBD that calculates the derivative</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.lib.std.IntegratorBlock">
+<em class="property">class </em><code class="descclassname">CBD.lib.std.</code><code class="descname">IntegratorBlock</code><span class="sig-paren">(</span><em>block_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/lib/std.html#IntegratorBlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.lib.std.IntegratorBlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="CBD.CBD.html#CBD.CBD.CBD" title="CBD.CBD.CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.CBD.CBD</span></code></a></p>
+<p>The integrator block is a CBD that calculates the integration.
+The block is implemented according to the trapezoid rule.</p>
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.realtime.html" class="btn btn-neutral float-right" title="CBD.realtime package" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.lib.interface.plotting.html" class="btn btn-neutral" title="CBD.lib.interface.plotting module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.lib.std module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.naivelog.html

@@ -0,0 +1,771 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.naivelog module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.simulator module" href="CBD.simulator.html" />
+    <link rel="prev" title="CBD.depGraph module" href="CBD.depGraph.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.naivelog module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.naivelog">
+<span id="cbd-naivelog-module"></span><h1>CBD.naivelog module<a class="headerlink" href="#module-CBD.naivelog" title="Permalink to this headline">¶</a></h1>
+<dl class="data">
+<dt id="CBD.naivelog.DEBUG">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">DEBUG</code><em class="property"> = 0</em><a class="headerlink" href="#CBD.naivelog.DEBUG" title="Permalink to this definition">¶</a></dt>
+<dd><p>Level identifier.</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="CBD.naivelog.INFO">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">INFO</code><em class="property"> = 1</em><a class="headerlink" href="#CBD.naivelog.INFO" title="Permalink to this definition">¶</a></dt>
+<dd><p>Level identifier.</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="CBD.naivelog.WARNING">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">WARNING</code><em class="property"> = 2</em><a class="headerlink" href="#CBD.naivelog.WARNING" title="Permalink to this definition">¶</a></dt>
+<dd><p>Level identifier.</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="CBD.naivelog.ERROR">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">ERROR</code><em class="property"> = 3</em><a class="headerlink" href="#CBD.naivelog.ERROR" title="Permalink to this definition">¶</a></dt>
+<dd><p>Level identifier.</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="CBD.naivelog.FATAL">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">FATAL</code><em class="property"> = 4</em><a class="headerlink" href="#CBD.naivelog.FATAL" title="Permalink to this definition">¶</a></dt>
+<dd><p>Level identifier.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="CBD.naivelog.strToLevel">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">strToLevel</code><span class="sig-paren">(</span><em>elvl</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#strToLevel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.strToLevel" title="Permalink to this definition">¶</a></dt>
+<dd><p>Go from string identifier of a logging level to the
+level identifier.</p>
+<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">Parameters:</th><td class="field-body"><strong>elvl</strong> (<em>str</em>) – Must be one of <code class="code docutils literal notranslate"><span class="pre">DEBUG</span></code>, <code class="code docutils literal notranslate"><span class="pre">INFO</span></code>,
+<code class="code docutils literal notranslate"><span class="pre">WARNING</span></code>, <code class="code docutils literal notranslate"><span class="pre">ERROR</span></code> or <code class="code docutils literal notranslate"><span class="pre">FATAL</span></code>,
+case-sensitive.</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.naivelog.levelToStr" title="CBD.naivelog.levelToStr"><code class="xref py py-func docutils literal notranslate"><span class="pre">levelToStr()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.naivelog.levelToShortStr" title="CBD.naivelog.levelToShortStr"><code class="xref py py-func docutils literal notranslate"><span class="pre">levelToShortStr()</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="function">
+<dt id="CBD.naivelog.levelToStr">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">levelToStr</code><span class="sig-paren">(</span><em>lvl</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#levelToStr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.levelToStr" title="Permalink to this definition">¶</a></dt>
+<dd><p>Go from a level identifier to the corresponding string representation.</p>
+<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">Parameters:</th><td class="field-body"><strong>lvl</strong> (<em>int</em>) – The level identifier.</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.naivelog.strToLevel" title="CBD.naivelog.strToLevel"><code class="xref py py-func docutils literal notranslate"><span class="pre">strToLevel()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.naivelog.levelToShortStr" title="CBD.naivelog.levelToShortStr"><code class="xref py py-func docutils literal notranslate"><span class="pre">levelToShortStr()</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="function">
+<dt id="CBD.naivelog.levelToShortStr">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">levelToShortStr</code><span class="sig-paren">(</span><em>lvl</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#levelToShortStr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.levelToShortStr" title="Permalink to this definition">¶</a></dt>
+<dd><p>Go from a level identifier to a short, representative string.</p>
+<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">Parameters:</th><td class="field-body"><strong>lvl</strong> (<em>int</em>) – The level identifier.</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.naivelog.strToLevel" title="CBD.naivelog.strToLevel"><code class="xref py py-func docutils literal notranslate"><span class="pre">strToLevel()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.naivelog.levelToStr" title="CBD.naivelog.levelToStr"><code class="xref py py-func docutils literal notranslate"><span class="pre">levelToStr()</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.naivelog.Logger">
+<em class="property">class </em><code class="descclassname">CBD.naivelog.</code><code class="descname">Logger</code><span class="sig-paren">(</span><em>modulename</em>, <em>level</em>, <em>crashlevel</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#Logger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.Logger" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>A simple logging class.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>modulename</strong> (<em>str</em>) – The name of the module.</li>
+<li><strong>level</strong> (<em>int</em>) – Lowest level for the logger to output.</li>
+<li><strong>crashlevel</strong> (<em>int</em>) – Level at which the logger should terminate.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
+<dt id="CBD.naivelog.Logger.debug">
+<code class="descname">debug</code><span class="sig-paren">(</span><em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#Logger.debug"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.Logger.debug" title="Permalink to this definition">¶</a></dt>
+<dd><p>Send <code class="code docutils literal notranslate"><span class="pre">DEBUG</span></code> message. Wrapper around the <a class="reference internal" href="#CBD.naivelog.Logger.log" title="CBD.naivelog.Logger.log"><code class="xref py py-func docutils literal notranslate"><span class="pre">log()</span></code></a> function.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>mainstr</strong> (<em>str</em>) – The main message information.</li>
+<li><strong>*args</strong> – List of arguments for formatting the <code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+<li><strong>**kwargs</strong> – List of keyword arguments for formatting the
+<code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.naivelog.Logger.info">
+<code class="descname">info</code><span class="sig-paren">(</span><em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#Logger.info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.Logger.info" title="Permalink to this definition">¶</a></dt>
+<dd><p>Send <code class="code docutils literal notranslate"><span class="pre">INFO</span></code> message. Wrapper around the <a class="reference internal" href="#CBD.naivelog.Logger.log" title="CBD.naivelog.Logger.log"><code class="xref py py-func docutils literal notranslate"><span class="pre">log()</span></code></a> function.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>mainstr</strong> (<em>str</em>) – The main message information.</li>
+<li><strong>*args</strong> – List of arguments for formatting the <code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+<li><strong>**kwargs</strong> – List of keyword arguments for formatting the
+<code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.naivelog.Logger.warning">
+<code class="descname">warning</code><span class="sig-paren">(</span><em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#Logger.warning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.Logger.warning" title="Permalink to this definition">¶</a></dt>
+<dd><p>Send <code class="code docutils literal notranslate"><span class="pre">WARNING</span></code> message. Wrapper around the <a class="reference internal" href="#CBD.naivelog.Logger.log" title="CBD.naivelog.Logger.log"><code class="xref py py-func docutils literal notranslate"><span class="pre">log()</span></code></a> function.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>mainstr</strong> (<em>str</em>) – The main message information.</li>
+<li><strong>*args</strong> – List of arguments for formatting the <code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+<li><strong>**kwargs</strong> – List of keyword arguments for formatting the
+<code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.naivelog.Logger.error">
+<code class="descname">error</code><span class="sig-paren">(</span><em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#Logger.error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.Logger.error" title="Permalink to this definition">¶</a></dt>
+<dd><p>Send <code class="code docutils literal notranslate"><span class="pre">ERROR</span></code> message. Wrapper around the <a class="reference internal" href="#CBD.naivelog.Logger.log" title="CBD.naivelog.Logger.log"><code class="xref py py-func docutils literal notranslate"><span class="pre">log()</span></code></a> function.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>mainstr</strong> (<em>str</em>) – The main message information.</li>
+<li><strong>*args</strong> – List of arguments for formatting the <code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+<li><strong>**kwargs</strong> – List of keyword arguments for formatting the
+<code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.naivelog.Logger.fatal">
+<code class="descname">fatal</code><span class="sig-paren">(</span><em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#Logger.fatal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.Logger.fatal" title="Permalink to this definition">¶</a></dt>
+<dd><p>Send <code class="code docutils literal notranslate"><span class="pre">FATAL</span></code> message. Wrapper around the <a class="reference internal" href="#CBD.naivelog.Logger.log" title="CBD.naivelog.Logger.log"><code class="xref py py-func docutils literal notranslate"><span class="pre">log()</span></code></a> function.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>mainstr</strong> (<em>str</em>) – The main message information.</li>
+<li><strong>*args</strong> – List of arguments for formatting the <code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+<li><strong>**kwargs</strong> – List of keyword arguments for formatting the
+<code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.naivelog.Logger.log">
+<code class="descname">log</code><span class="sig-paren">(</span><em>level</em>, <em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#Logger.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.Logger.log" title="Permalink to this definition">¶</a></dt>
+<dd><p>Send a message.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>level</strong> (<em>int</em>) – Level at which there must be logged.</li>
+<li><strong>mainstr</strong> (<em>str</em>) – The main message information.</li>
+<li><strong>*args</strong> – List of arguments for formatting the <code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+<li><strong>**kwargs</strong> – List of keyword arguments for formatting the
+<code class="code docutils literal notranslate"><span class="pre">mainstr</span></code>.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.naivelog.Logger.debug" title="CBD.naivelog.Logger.debug"><code class="xref py py-func docutils literal notranslate"><span class="pre">debug()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.naivelog.Logger.info" title="CBD.naivelog.Logger.info"><code class="xref py py-func docutils literal notranslate"><span class="pre">info()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.naivelog.Logger.warning" title="CBD.naivelog.Logger.warning"><code class="xref py py-func docutils literal notranslate"><span class="pre">warning()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.naivelog.Logger.error" title="CBD.naivelog.Logger.error"><code class="xref py py-func docutils literal notranslate"><span class="pre">error()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.naivelog.Logger.fatal" title="CBD.naivelog.Logger.fatal"><code class="xref py py-func docutils literal notranslate"><span class="pre">fatal()</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.naivelog.Logger.setLevel">
+<code class="descname">setLevel</code><span class="sig-paren">(</span><em>level</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#Logger.setLevel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.Logger.setLevel" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the level to a new value.</p>
+<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">Parameters:</th><td class="field-body"><strong>level</strong> (<em>int</em>) – The new level.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.naivelog.Logger.formatmsg">
+<code class="descname">formatmsg</code><span class="sig-paren">(</span><em>level</em>, <em>mainstr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#Logger.formatmsg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.Logger.formatmsg" title="Permalink to this definition">¶</a></dt>
+<dd><p>Formats the message, used internally.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>level</strong> (<em>int</em>) – The level of the message.</li>
+<li><strong>mainstr</strong> (<em>str</em>) – The main message to print.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="data">
+<dt id="CBD.naivelog.defaultLogLevel">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">defaultLogLevel</code><em class="property"> = 1</em><a class="headerlink" href="#CBD.naivelog.defaultLogLevel" title="Permalink to this definition">¶</a></dt>
+<dd><p>Default level at which logging is enabled.</p>
+</dd></dl>
+
+<dl class="data">
+<dt id="CBD.naivelog.defaultCrashLevel">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">defaultCrashLevel</code><em class="property"> = 4</em><a class="headerlink" href="#CBD.naivelog.defaultCrashLevel" title="Permalink to this definition">¶</a></dt>
+<dd><p>Default level at which a termination must occur.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="CBD.naivelog.getAbstractLogLevel">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">getAbstractLogLevel</code><span class="sig-paren">(</span><em>env</em>, <em>default</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#getAbstractLogLevel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.getAbstractLogLevel" title="Permalink to this definition">¶</a></dt>
+<dd><p>Obtains the log level from the environment variables.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>env</strong> (<em>str</em>) – Variable name.</li>
+<li><strong>default</strong> (<em>Any</em>) – The default value if the variable does not
+exist.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="CBD.naivelog.getLogLevel">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">getLogLevel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#getLogLevel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.getLogLevel" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the logging level from the environment.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="CBD.naivelog.getCrashLevel">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">getCrashLevel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#getCrashLevel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.getCrashLevel" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the crash level from the environment.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="CBD.naivelog.getLogger">
+<code class="descclassname">CBD.naivelog.</code><code class="descname">getLogger</code><span class="sig-paren">(</span><em>modulename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/naivelog.html#getLogger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.naivelog.getLogger" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the logger for a certain module.</p>
+<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">Parameters:</th><td class="field-body"><strong>modulename</strong> (<em>str</em>) – The module’s name.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.simulator.html" class="btn btn-neutral float-right" title="CBD.simulator module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.depGraph.html" class="btn btn-neutral" title="CBD.depGraph module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.naivelog module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.realtime.html

@@ -0,0 +1,450 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.realtime package &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.realtime.plotting module" href="CBD.realtime.plotting.html" />
+    <link rel="prev" title="CBD.lib.std module" href="CBD.lib.std.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.realtime package</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.realtime">
+<span id="cbd-realtime-package"></span><h1>CBD.realtime package<a class="headerlink" href="#module-CBD.realtime" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="CBD.realtime.plotting.html">CBD.realtime.plotting module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.realtime.threadingBackend.html">CBD.realtime.threadingBackend module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.realtime.threadingGameLoop.html">CBD.realtime.threadingGameLoop module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.realtime.threadingPython.html">CBD.realtime.threadingPython module</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CBD.realtime.threadingTkInter.html">CBD.realtime.threadingTkInter module</a></li>
+</ul>
+</div>
+</div>
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.realtime.plotting.html" class="btn btn-neutral float-right" title="CBD.realtime.plotting module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.lib.std.html" class="btn btn-neutral" title="CBD.lib.std module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.realtime package</a><ul>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+</ul>
+</li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.realtime.threadingGameLoop.html

@@ -0,0 +1,475 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.realtime.threadingGameLoop module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.realtime.threadingPython module" href="CBD.realtime.threadingPython.html" />
+    <link rel="prev" title="CBD.realtime.threadingBackend module" href="CBD.realtime.threadingBackend.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+          <li><a href="CBD.realtime.html">CBD.realtime package</a> &gt;</li>
+        
+      <li>CBD.realtime.threadingGameLoop module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.realtime.threadingGameLoop">
+<span id="cbd-realtime-threadinggameloop-module"></span><h1>CBD.realtime.threadingGameLoop module<a class="headerlink" href="#module-CBD.realtime.threadingGameLoop" title="Permalink to this headline">¶</a></h1>
+<dl class="class">
+<dt id="CBD.realtime.threadingGameLoop.ThreadingGameLoop">
+<em class="property">class </em><code class="descclassname">CBD.realtime.threadingGameLoop.</code><code class="descname">ThreadingGameLoop</code><a class="reference internal" href="_modules/CBD/realtime/threadingGameLoop.html#ThreadingGameLoop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingGameLoop.ThreadingGameLoop" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Game loop subsystem for realtime simulation.
+Time will only progress when a <a class="reference internal" href="#CBD.realtime.threadingGameLoop.ThreadingGameLoop.step" title="CBD.realtime.threadingGameLoop.ThreadingGameLoop.step"><code class="xref py py-func docutils literal notranslate"><span class="pre">step()</span></code></a> call is made.</p>
+<dl class="method">
+<dt id="CBD.realtime.threadingGameLoop.ThreadingGameLoop.step">
+<code class="descname">step</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingGameLoop.html#ThreadingGameLoop.step"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingGameLoop.ThreadingGameLoop.step" title="Permalink to this definition">¶</a></dt>
+<dd><p>Perform a step in the simulation. Actual processing is done in a seperate thread.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.realtime.threadingGameLoop.ThreadingGameLoop.wait">
+<code class="descname">wait</code><span class="sig-paren">(</span><em>delay</em>, <em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingGameLoop.html#ThreadingGameLoop.wait"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingGameLoop.ThreadingGameLoop.wait" title="Permalink to this definition">¶</a></dt>
+<dd><p>Wait for the specified time, or faster if interrupted</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>delay</strong> – time to wait</li>
+<li><strong>func</strong> – the function to call</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.realtime.threadingGameLoop.ThreadingGameLoop.interrupt">
+<code class="descname">interrupt</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingGameLoop.html#ThreadingGameLoop.interrupt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingGameLoop.ThreadingGameLoop.interrupt" title="Permalink to this definition">¶</a></dt>
+<dd><p>Interrupt the waiting thread</p>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.realtime.threadingPython.html" class="btn btn-neutral float-right" title="CBD.realtime.threadingPython module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.realtime.threadingBackend.html" class="btn btn-neutral" title="CBD.realtime.threadingBackend module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.realtime.threadingGameLoop module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.realtime.threadingPython.html

@@ -0,0 +1,488 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.realtime.threadingPython module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.realtime.threadingTkInter module" href="CBD.realtime.threadingTkInter.html" />
+    <link rel="prev" title="CBD.realtime.threadingGameLoop module" href="CBD.realtime.threadingGameLoop.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+          <li><a href="CBD.realtime.html">CBD.realtime package</a> &gt;</li>
+        
+      <li>CBD.realtime.threadingPython module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.realtime.threadingPython">
+<span id="cbd-realtime-threadingpython-module"></span><h1>CBD.realtime.threadingPython module<a class="headerlink" href="#module-CBD.realtime.threadingPython" title="Permalink to this headline">¶</a></h1>
+<dl class="class">
+<dt id="CBD.realtime.threadingPython.ThreadingPython">
+<em class="property">class </em><code class="descclassname">CBD.realtime.threadingPython.</code><code class="descname">ThreadingPython</code><a class="reference internal" href="_modules/CBD/realtime/threadingPython.html#ThreadingPython"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingPython.ThreadingPython" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Simple Python threads subsystem</p>
+<dl class="method">
+<dt id="CBD.realtime.threadingPython.ThreadingPython.wait">
+<code class="descname">wait</code><span class="sig-paren">(</span><em>delay</em>, <em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingPython.html#ThreadingPython.wait"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingPython.ThreadingPython.wait" title="Permalink to this definition">¶</a></dt>
+<dd><p>Wait for the specified time, or faster if interrupted</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>delay</strong> – time to wait</li>
+<li><strong>func</strong> – the function to call</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.realtime.threadingPython.ThreadingPython.interrupt">
+<code class="descname">interrupt</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingPython.html#ThreadingPython.interrupt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingPython.ThreadingPython.interrupt" title="Permalink to this definition">¶</a></dt>
+<dd><p>Interrupt the waiting thread</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.realtime.threadingPython.ThreadingPython.callFunc">
+<code class="descname">callFunc</code><span class="sig-paren">(</span><em>delay</em>, <em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingPython.html#ThreadingPython.callFunc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingPython.ThreadingPython.callFunc" title="Permalink to this definition">¶</a></dt>
+<dd><p>Function to call on a seperate thread: will block for the
+specified time and call the function afterwards</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>delay</strong> (<em>float</em>) – The wait delay.</li>
+<li><strong>func</strong> – The function to call. No arguments can be
+used and no return values are needed.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.realtime.threadingTkInter.html" class="btn btn-neutral float-right" title="CBD.realtime.threadingTkInter module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.realtime.threadingGameLoop.html" class="btn btn-neutral" title="CBD.realtime.threadingGameLoop module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.realtime.threadingPython module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.realtime.threadingTkInter.html

@@ -0,0 +1,492 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.realtime.threadingTkInter module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.CBD module" href="CBD.CBD.html" />
+    <link rel="prev" title="CBD.realtime.threadingPython module" href="CBD.realtime.threadingPython.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+          <li><a href="CBD.realtime.html">CBD.realtime package</a> &gt;</li>
+        
+      <li>CBD.realtime.threadingTkInter module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.realtime.threadingTkInter">
+<span id="cbd-realtime-threadingtkinter-module"></span><h1>CBD.realtime.threadingTkInter module<a class="headerlink" href="#module-CBD.realtime.threadingTkInter" title="Permalink to this headline">¶</a></h1>
+<dl class="function">
+<dt id="CBD.realtime.threadingTkInter.tkMainThreadPoller">
+<code class="descclassname">CBD.realtime.threadingTkInter.</code><code class="descname">tkMainThreadPoller</code><span class="sig-paren">(</span><em>tk</em>, <em>queue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingTkInter.html#tkMainThreadPoller"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingTkInter.tkMainThreadPoller" title="Permalink to this definition">¶</a></dt>
+<dd><p>The polling function to register with Tk at the start. This will do the actual scheduling in Tk.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>tk</strong> – the Tk instance to use</li>
+<li><strong>queue</strong> – the queue to check</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.realtime.threadingTkInter.ThreadingTkInter">
+<em class="property">class </em><code class="descclassname">CBD.realtime.threadingTkInter.</code><code class="descname">ThreadingTkInter</code><span class="sig-paren">(</span><em>tk</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingTkInter.html#ThreadingTkInter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingTkInter.ThreadingTkInter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Tk Inter subsystem for realtime simulation</p>
+<dl class="method">
+<dt id="CBD.realtime.threadingTkInter.ThreadingTkInter.unlock">
+<code class="descname">unlock</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingTkInter.html#ThreadingTkInter.unlock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingTkInter.ThreadingTkInter.unlock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Unlock the waiting thread</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.realtime.threadingTkInter.ThreadingTkInter.wait">
+<code class="descname">wait</code><span class="sig-paren">(</span><em>t</em>, <em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingTkInter.html#ThreadingTkInter.wait"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingTkInter.ThreadingTkInter.wait" title="Permalink to this definition">¶</a></dt>
+<dd><p>Wait for the specified time, or faster if interrupted</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>t</strong> – time to wait</li>
+<li><strong>func</strong> – the function to call</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.realtime.threadingTkInter.ThreadingTkInter.interrupt">
+<code class="descname">interrupt</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/realtime/threadingTkInter.html#ThreadingTkInter.interrupt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.realtime.threadingTkInter.ThreadingTkInter.interrupt" title="Permalink to this definition">¶</a></dt>
+<dd><p>Interrupt the waiting thread</p>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.CBD.html" class="btn btn-neutral float-right" title="CBD.CBD module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.realtime.threadingPython.html" class="btn btn-neutral" title="CBD.realtime.threadingPython module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.realtime.threadingTkInter module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.simulator.html

@@ -0,0 +1,783 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.simulator module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.solver module" href="CBD.solver.html" />
+    <link rel="prev" title="CBD.naivelog module" href="CBD.naivelog.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.simulator module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.simulator">
+<span id="cbd-simulator-module"></span><h1>CBD.simulator module<a class="headerlink" href="#module-CBD.simulator" title="Permalink to this headline">¶</a></h1>
+<dl class="class">
+<dt id="CBD.simulator.Clock">
+<em class="property">class </em><code class="descclassname">CBD.simulator.</code><code class="descname">Clock</code><span class="sig-paren">(</span><em>delta_t</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Clock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Clock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>The clock of the simulation.</p>
+<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">Parameters:</th><td class="field-body"><strong>delta_t</strong> (<em>float</em>) – Delay in-between timesteps in the simulation.</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
+<dt id="CBD.simulator.Clock.getTime">
+<code class="descname">getTime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Clock.getTime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Clock.getTime" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the current simulation time.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Clock.step">
+<code class="descname">step</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Clock.step"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Clock.step" title="Permalink to this definition">¶</a></dt>
+<dd><p>Executes a timestep on the simulation.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Clock.setDeltaT">
+<code class="descname">setDeltaT</code><span class="sig-paren">(</span><em>new_delta_t</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Clock.setDeltaT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Clock.setDeltaT" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the delta in-between timesteps.</p>
+<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">Parameters:</th><td class="field-body"><strong>new_delta_t</strong> (<em>float</em>) – The new delta.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Clock.getDeltaT">
+<code class="descname">getDeltaT</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Clock.getDeltaT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Clock.getDeltaT" title="Permalink to this definition">¶</a></dt>
+<dd><p>Obtains the current delta.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.simulator.Simulator">
+<em class="property">class </em><code class="descclassname">CBD.simulator.</code><code class="descname">Simulator</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Simulator for a CBD model. Allows for execution of the simulation.
+This class implements the semantics of CBDs.</p>
+<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">Parameters:</th><td class="field-body"><strong>model</strong> (<a class="reference internal" href="CBD.CBD.html#CBD.CBD.CBD" title="CBD.CBD.CBD"><em>CBD</em></a>) – A <a class="reference internal" href="CBD.html#module-CBD" title="CBD"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD</span></code></a> model to simulate.</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
+<dt id="CBD.simulator.Simulator.run">
+<code class="descname">run</code><span class="sig-paren">(</span><em>term_time=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.run" title="Permalink to this definition">¶</a></dt>
+<dd><p>Simulates the model.</p>
+<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">Parameters:</th><td class="field-body"><strong>term_time</strong> (<em>float</em>) – When not <code class="code docutils literal notranslate"><span class="pre">None</span></code>, overwrites the
+termination time with the new value.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.is_running">
+<code class="descname">is_running</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.is_running"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.is_running" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns <code class="code docutils literal notranslate"><span class="pre">True</span></code> as long as the simulation is running.
+This is a convenience function to keep real-time simulations
+alive, or to interact from external sources.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.getClock">
+<code class="descname">getClock</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.getClock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.getClock" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the simulation clock.</p>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.simulator.Simulator.getTime" title="CBD.simulator.Simulator.getTime"><code class="xref py py-func docutils literal notranslate"><span class="pre">getTime()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.getDeltaT" title="CBD.simulator.Simulator.getDeltaT"><code class="xref py py-func docutils literal notranslate"><span class="pre">getDeltaT()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setDeltaT" title="CBD.simulator.Simulator.setDeltaT"><code class="xref py py-func docutils literal notranslate"><span class="pre">setDeltaT()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Clock" title="CBD.simulator.Clock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clock</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.getTime">
+<code class="descname">getTime</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.getTime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.getTime" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the current simulation time.</p>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.simulator.Simulator.getClock" title="CBD.simulator.Simulator.getClock"><code class="xref py py-func docutils literal notranslate"><span class="pre">getClock()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.getDeltaT" title="CBD.simulator.Simulator.getDeltaT"><code class="xref py py-func docutils literal notranslate"><span class="pre">getDeltaT()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setDeltaT" title="CBD.simulator.Simulator.setDeltaT"><code class="xref py py-func docutils literal notranslate"><span class="pre">setDeltaT()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Clock" title="CBD.simulator.Clock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clock</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.setDeltaT">
+<code class="descname">setDeltaT</code><span class="sig-paren">(</span><em>delta_t</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.setDeltaT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.setDeltaT" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the delta in-between iteration steps.</p>
+<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">Parameters:</th><td class="field-body"><strong>delta_t</strong> (<em>float</em>) – The delta.</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.simulator.Simulator.getClock" title="CBD.simulator.Simulator.getClock"><code class="xref py py-func docutils literal notranslate"><span class="pre">getClock()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.getTime" title="CBD.simulator.Simulator.getTime"><code class="xref py py-func docutils literal notranslate"><span class="pre">getTime()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.getDeltaT" title="CBD.simulator.Simulator.getDeltaT"><code class="xref py py-func docutils literal notranslate"><span class="pre">getDeltaT()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Clock" title="CBD.simulator.Clock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clock</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.getDeltaT">
+<code class="descname">getDeltaT</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.getDeltaT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.getDeltaT" title="Permalink to this definition">¶</a></dt>
+<dd><p>Gets the delta in-between iteration steps.</p>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.simulator.Simulator.getClock" title="CBD.simulator.Simulator.getClock"><code class="xref py py-func docutils literal notranslate"><span class="pre">getClock()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.getTime" title="CBD.simulator.Simulator.getTime"><code class="xref py py-func docutils literal notranslate"><span class="pre">getTime()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setDeltaT" title="CBD.simulator.Simulator.setDeltaT"><code class="xref py py-func docutils literal notranslate"><span class="pre">setDeltaT()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Clock" title="CBD.simulator.Clock"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clock</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.setRealTime">
+<code class="descname">setRealTime</code><span class="sig-paren">(</span><em>enabled=True</em>, <em>scale=1.0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.setRealTime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.setRealTime" title="Permalink to this definition">¶</a></dt>
+<dd><p>Makes the simulation run in (scaled) real time.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>enabled</strong> (<em>bool</em>) – When <code class="code docutils literal notranslate"><span class="pre">True</span></code>, realtime simulation will be enabled.
+Otherwise, it will be disabled. Defaults to <code class="code docutils literal notranslate"><span class="pre">True</span></code>.</li>
+<li><strong>scale</strong> (<em>float</em>) – Optional scaling for the simulation time. When greater
+than 1, the simulation will run slower than the actual
+time. When &lt; 1, it will run faster.
+E.g. <code class="code docutils literal notranslate"><span class="pre">scale</span> <span class="pre">=</span> <span class="pre">2.0</span></code> will run twice as long.
+Defaults to <code class="code docutils literal notranslate"><span class="pre">1.0</span></code>.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.setProgressBar">
+<code class="descname">setProgressBar</code><span class="sig-paren">(</span><em>enabled=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.setProgressBar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.setProgressBar" title="Permalink to this definition">¶</a></dt>
+<dd><p>Use the <a class="reference external" href="https://tqdm.github.io/">tdqm</a> package to display a progress bar
+of the simulation.</p>
+<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">Parameters:</th><td class="field-body"><strong>enabled</strong> (<em>bool</em>) – Whether or not to enable/disable the progress bar.
+Defaults to <code class="code docutils literal notranslate"><span class="pre">True</span></code> (= show progress bar).</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AssertionError</span></code> – if the <code class="code docutils literal notranslate"><span class="pre">tqdm</span></code> module cannot be located.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.setTerminationCondition">
+<code class="descname">setTerminationCondition</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.setTerminationCondition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.setTerminationCondition" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the system’s termination condition.</p>
+<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">Parameters:</th><td class="field-body"><strong>func</strong> – A function that takes the model and the current iteration as input
+and produces <code class="code docutils literal notranslate"><span class="pre">True</span></code> if the simulation needs to terminate.</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">When set, the progress bars (see <a class="reference internal" href="#CBD.simulator.Simulator.setProgressBar" title="CBD.simulator.Simulator.setProgressBar"><code class="xref py py-func docutils literal notranslate"><span class="pre">setProgressBar()</span></code></a>) may not work as intended.</p>
+</div>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<p class="last"><a class="reference internal" href="#CBD.simulator.Simulator.setTerminationTime" title="CBD.simulator.Simulator.setTerminationTime"><code class="xref py py-func docutils literal notranslate"><span class="pre">setTerminationTime()</span></code></a></p>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.setTerminationTime">
+<code class="descname">setTerminationTime</code><span class="sig-paren">(</span><em>term_time</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.setTerminationTime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.setTerminationTime" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the termination time of the system.</p>
+<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">Parameters:</th><td class="field-body"><strong>term_time</strong> (<em>float</em>) – Termination time for the simulation.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.setRealTimePlatform">
+<code class="descname">setRealTimePlatform</code><span class="sig-paren">(</span><em>subsystem</em>, <em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.setRealTimePlatform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.setRealTimePlatform" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the realtime platform to a platform of choice.
+This allows more complex/efficient simulations.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>subsystem</strong> (<a class="reference internal" href="CBD.realtime.threadingBackend.html#CBD.realtime.threadingBackend.Platform" title="CBD.realtime.threadingBackend.Platform"><em>Platform</em></a>) – The platform to use.</li>
+<li><strong>args</strong> – Optional arguments for this platform.
+Currently, only the TkInter platform
+makes use of these arguments.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">To prevent misuse of the function, please use one of the wrapper
+functions when you have no idea what you’re doing.</p>
+</div>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatformThreading" title="CBD.simulator.Simulator.setRealTimePlatformThreading"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatformThreading()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatformTk" title="CBD.simulator.Simulator.setRealTimePlatformTk"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatformTk()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatformGameLoop" title="CBD.simulator.Simulator.setRealTimePlatformGameLoop"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatformGameLoop()</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.setRealTimePlatformThreading">
+<code class="descname">setRealTimePlatformThreading</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.setRealTimePlatformThreading"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.setRealTimePlatformThreading" title="Permalink to this definition">¶</a></dt>
+<dd><p>Wrapper around the <a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatform" title="CBD.simulator.Simulator.setRealTimePlatform"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatform()</span></code></a> call to automatically
+set the Python Threading backend.</p>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatform" title="CBD.simulator.Simulator.setRealTimePlatform"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatform()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatformTk" title="CBD.simulator.Simulator.setRealTimePlatformTk"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatformTk()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatformGameLoop" title="CBD.simulator.Simulator.setRealTimePlatformGameLoop"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatformGameLoop()</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.setRealTimePlatformGameLoop">
+<code class="descname">setRealTimePlatformGameLoop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.setRealTimePlatformGameLoop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.setRealTimePlatformGameLoop" title="Permalink to this definition">¶</a></dt>
+<dd><p>Wrapper around the <a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatform" title="CBD.simulator.Simulator.setRealTimePlatform"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatform()</span></code></a> call to automatically
+set the Python Threading backend.</p>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatform" title="CBD.simulator.Simulator.setRealTimePlatform"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatform()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatformThreading" title="CBD.simulator.Simulator.setRealTimePlatformThreading"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatformThreading()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatformTk" title="CBD.simulator.Simulator.setRealTimePlatformTk"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatformTk()</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.setRealTimePlatformTk">
+<code class="descname">setRealTimePlatformTk</code><span class="sig-paren">(</span><em>root</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.setRealTimePlatformTk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.setRealTimePlatformTk" title="Permalink to this definition">¶</a></dt>
+<dd><p>Wrapper around the <a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatform" title="CBD.simulator.Simulator.setRealTimePlatform"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatform()</span></code></a> call to automatically
+set the TkInter backend.</p>
+<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">Parameters:</th><td class="field-body"><strong>root</strong> – TkInter root window object (tkinter.Tk)</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatform" title="CBD.simulator.Simulator.setRealTimePlatform"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatform()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatformThreading" title="CBD.simulator.Simulator.setRealTimePlatformThreading"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatformThreading()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatformGameLoop" title="CBD.simulator.Simulator.setRealTimePlatformGameLoop"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatformGameLoop()</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.realtime_gameloop_call">
+<code class="descname">realtime_gameloop_call</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.realtime_gameloop_call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.realtime_gameloop_call" title="Permalink to this definition">¶</a></dt>
+<dd><p>Do a step in the realtime-gameloop platform.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">This function will only work for a <code class="xref py py-attr docutils literal notranslate"><span class="pre">Platform.GAMELOOP</span></code> simulation,
+after the <a class="reference internal" href="#CBD.simulator.Simulator.run" title="CBD.simulator.Simulator.run"><code class="xref py py-func docutils literal notranslate"><span class="pre">run()</span></code></a> method has been called.</p>
+</div>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<ul class="last simple">
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatform" title="CBD.simulator.Simulator.setRealTimePlatform"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatform()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.setRealTimePlatformGameLoop" title="CBD.simulator.Simulator.setRealTimePlatformGameLoop"><code class="xref py py-func docutils literal notranslate"><span class="pre">setRealTimePlatformGameLoop()</span></code></a></li>
+<li><a class="reference internal" href="#CBD.simulator.Simulator.run" title="CBD.simulator.Simulator.run"><code class="xref py py-func docutils literal notranslate"><span class="pre">run()</span></code></a></li>
+</ul>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator.Simulator.getDurationLog">
+<code class="descname">getDurationLog</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator.html#Simulator.getDurationLog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator.Simulator.getDurationLog" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the list of timings for every iteration.</p>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">This function is temporary and will be removed in the future.</p>
+</div>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.solver.html" class="btn btn-neutral float-right" title="CBD.solver module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.naivelog.html" class="btn btn-neutral" title="CBD.naivelog module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.simulator module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.simulator2.html

@@ -0,0 +1,451 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.simulator2 module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.solver module" href="CBD.solver.html" />
+    <link rel="prev" title="CBD.simulator module" href="CBD.simulator.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.simulator2 module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.simulator2">
+<span id="cbd-simulator2-module"></span><h1>CBD.simulator2 module<a class="headerlink" href="#module-CBD.simulator2" title="Permalink to this headline">¶</a></h1>
+<dl class="class">
+<dt id="CBD.simulator2.Simulator">
+<em class="property">class </em><code class="descclassname">CBD.simulator2.</code><code class="descname">Simulator</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator2.html#Simulator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator2.Simulator" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="method">
+<dt id="CBD.simulator2.Simulator.is_running">
+<code class="descname">is_running</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator2.html#Simulator.is_running"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator2.Simulator.is_running" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="CBD.simulator2.Simulator.run">
+<code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/simulator2.html#Simulator.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.simulator2.Simulator.run" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.solver.html" class="btn btn-neutral float-right" title="CBD.solver module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.simulator.html" class="btn btn-neutral" title="CBD.simulator module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.simulator2 module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.solver.html

@@ -0,0 +1,581 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.solver module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="CBD.util module" href="CBD.util.html" />
+    <link rel="prev" title="CBD.simulator module" href="CBD.simulator.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.solver module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.solver">
+<span id="cbd-solver-module"></span><h1>CBD.solver module<a class="headerlink" href="#module-CBD.solver" title="Permalink to this headline">¶</a></h1>
+<dl class="class">
+<dt id="CBD.solver.Solver">
+<em class="property">class </em><code class="descclassname">CBD.solver.</code><code class="descname">Solver</code><span class="sig-paren">(</span><em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/solver.html#Solver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.solver.Solver" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Superclass that can solve algebraic loops.</p>
+<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">Parameters:</th><td class="field-body"><strong>logger</strong> (<a class="reference internal" href="CBD.naivelog.html#CBD.naivelog.Logger" title="CBD.naivelog.Logger"><em>Logger</em></a>) – The logger to use.</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
+<dt id="CBD.solver.Solver.checkValidity">
+<code class="descname">checkValidity</code><span class="sig-paren">(</span><em>path</em>, <em>component</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/solver.html#Solver.checkValidity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.solver.Solver.checkValidity" title="Permalink to this definition">¶</a></dt>
+<dd><p>Checks the validity of an algebraic loop.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>path</strong> (<em>str</em>) – The path of the top-level block.</li>
+<li><strong>component</strong> (<em>list</em>) – The blocks in the algebraic loop.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.solver.Solver.constructInput">
+<code class="descname">constructInput</code><span class="sig-paren">(</span><em>component</em>, <em>curIt</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/solver.html#Solver.constructInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.solver.Solver.constructInput" title="Permalink to this definition">¶</a></dt>
+<dd><p>Constructs input for the solver.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>component</strong> (<em>list</em>) – The blocks in the algebraic loop.</li>
+<li><strong>curIt</strong> (<em>int</em>) – The current iteration of the simulation.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<p class="last"><a class="reference internal" href="#CBD.solver.Solver.solve" title="CBD.solver.Solver.solve"><code class="xref py py-func docutils literal notranslate"><span class="pre">solve()</span></code></a></p>
+</div>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.solver.Solver.solve">
+<code class="descname">solve</code><span class="sig-paren">(</span><em>solverInput</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/solver.html#Solver.solve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.solver.Solver.solve" title="Permalink to this definition">¶</a></dt>
+<dd><p>Solves the algebraic loop.</p>
+<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">Parameters:</th><td class="field-body"><strong>solverInput</strong> – The constructed input.</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<p class="last"><a class="reference internal" href="#CBD.solver.Solver.constructInput" title="CBD.solver.Solver.constructInput"><code class="xref py py-func docutils literal notranslate"><span class="pre">constructInput()</span></code></a></p>
+</div>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.solver.GaussianJordanLinearSolver">
+<em class="property">class </em><code class="descclassname">CBD.solver.</code><code class="descname">GaussianJordanLinearSolver</code><span class="sig-paren">(</span><em>logger</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/solver.html#GaussianJordanLinearSolver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.solver.GaussianJordanLinearSolver" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#CBD.solver.Solver" title="CBD.solver.Solver"><code class="xref py py-class docutils literal notranslate"><span class="pre">CBD.solver.Solver</span></code></a></p>
+<p>Solves linear algebraic loops via Gaussian-Jordan Elimination.</p>
+<dl class="method">
+<dt id="CBD.solver.GaussianJordanLinearSolver.checkValidity">
+<code class="descname">checkValidity</code><span class="sig-paren">(</span><em>path</em>, <em>component</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/solver.html#GaussianJordanLinearSolver.checkValidity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.solver.GaussianJordanLinearSolver.checkValidity" title="Permalink to this definition">¶</a></dt>
+<dd><p>Checks the validity of an algebraic loop.</p>
+<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">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>path</strong> (<em>str</em>) – The path of the top-level block.</li>
+<li><strong>component</strong> (<em>list</em>) – The blocks in the algebraic loop.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.solver.GaussianJordanLinearSolver.constructInput">
+<code class="descname">constructInput</code><span class="sig-paren">(</span><em>strongComponent</em>, <em>curIteration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/solver.html#GaussianJordanLinearSolver.constructInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.solver.GaussianJordanLinearSolver.constructInput" title="Permalink to this definition">¶</a></dt>
+<dd><p>Constructs input for a solver of systems of linear equations
+Input consists of two matrices:</p>
+<blockquote>
+<div><ul class="simple">
+<li>M1: coefficient matrix, where each row represents an equation of the system</li>
+<li>M2: result matrix, where each element is the result for the corresponding equation in M1</li>
+</ul>
+</div></blockquote>
+</dd></dl>
+
+<dl class="method">
+<dt id="CBD.solver.GaussianJordanLinearSolver.solve">
+<code class="descname">solve</code><span class="sig-paren">(</span><em>solverInput</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/solver.html#GaussianJordanLinearSolver.solve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.solver.GaussianJordanLinearSolver.solve" title="Permalink to this definition">¶</a></dt>
+<dd><p>Solves the algebraic loop.</p>
+<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">Parameters:</th><td class="field-body"><strong>solverInput</strong> – The constructed input.</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<p class="last"><a class="reference internal" href="#CBD.solver.GaussianJordanLinearSolver.constructInput" title="CBD.solver.GaussianJordanLinearSolver.constructInput"><code class="xref py py-func docutils literal notranslate"><span class="pre">constructInput()</span></code></a></p>
+</div>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="CBD.solver.Matrix">
+<em class="property">class </em><code class="descclassname">CBD.solver.</code><code class="descname">Matrix</code><span class="sig-paren">(</span><em>rows</em>, <em>cols</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/solver.html#Matrix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.solver.Matrix" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Custom, efficient matrix class. This class is used for efficiency purposes.</p>
+<blockquote>
+<div><ul class="simple">
+<li>Using a while/for loop is slow.</li>
+<li>Using <code class="xref py py-class docutils literal notranslate"><span class="pre">[[0]</span> <span class="pre">*</span> <span class="pre">n]</span> <span class="pre">*</span> <span class="pre">n</span></code> will have n references to the same list.</li>
+<li>Using <code class="xref py py-class docutils literal notranslate"><span class="pre">[[0]</span> <span class="pre">*</span> <span class="pre">size</span> <span class="pre">for</span> <span class="pre">_</span> <span class="pre">in</span> <span class="pre">range(size)]</span></code> can be 5 times slower
+than this class!</li>
+</ul>
+</div></blockquote>
+<p>Numpy could be used to even further increase efficiency, but this increases the
+required dependencies for external hardware systems (that may not provide these options).</p>
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="CBD.util.html" class="btn btn-neutral float-right" title="CBD.util module" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
+      
+      
+        <a href="CBD.simulator.html" class="btn btn-neutral" title="CBD.simulator module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.solver module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/CBD.src.CBDDraw.html

@@ -1,116 +0,0 @@
-
-<!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="X-UA-Compatible" content="IE=Edge" />
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>CBD.src.CBDDraw module &#8212; CBD Simulation Development Kit  documentation</title>
-    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" type="text/css" href="_static/style.css" />
-    
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
-    <script type="text/javascript" src="_static/language_data.js"></script>
-    <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>
-    
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="CBD.src.naivelog module" href="CBD.src.naivelog.html" />
-    <link rel="prev" title="CBD.src.CBD module" href="CBD.src.CBD.html" /> 
-  </head><body>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.src.naivelog.html" title="CBD.src.naivelog module"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="CBD.src.CBD.html" title="CBD.src.CBD module"
-             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="CBD.src.html" accesskey="U">CBD.src package</a> &#187;</li> 
-      </ul>
-    </div>  
-
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
-            
-  <div class="section" id="module-CBD.src.CBDDraw">
-<span id="cbd-src-cbddraw-module"></span><h1>CBD.src.CBDDraw module<a class="headerlink" href="#module-CBD.src.CBDDraw" title="Permalink to this headline">¶</a></h1>
-<dl class="function">
-<dt id="CBD.src.CBDDraw.draw">
-<code class="descclassname">CBD.src.CBDDraw.</code><code class="descname">draw</code><span class="sig-paren">(</span><em>cbd</em>, <em>filename</em>, <em>colors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.CBDDraw.draw" title="Permalink to this definition">¶</a></dt>
-<dd><p>Output cbd as a dot script to filename.</p>
-<p>colors is a dictionary of blockname =&gt; color</p>
-</dd></dl>
-
-</div>
-
-
-          </div>
-        </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="CBD.src.CBD.html"
-                        title="previous chapter">CBD.src.CBD module</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="CBD.src.naivelog.html"
-                        title="next chapter">CBD.src.naivelog module</a></p>
-<div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
-    <div class="searchformwrapper">
-    <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>
-    </div>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
-        </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.src.naivelog.html" title="CBD.src.naivelog module"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="CBD.src.CBD.html" title="CBD.src.CBD module"
-             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="CBD.src.html" >CBD.src package</a> &#187;</li> 
-      </ul>
-    </div>
-    <div class="footer" role="contentinfo">
-        &#169; Copyright 2020, Randy Paredis.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
-    </div>
-  </body>
-</html>

doc/_build/html/CBD.src.html

@@ -1,125 +0,0 @@
-
-<!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="X-UA-Compatible" content="IE=Edge" />
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>CBD.src package &#8212; CBD Simulation Development Kit  documentation</title>
-    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" type="text/css" href="_static/style.css" />
-    
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
-    <script type="text/javascript" src="_static/language_data.js"></script>
-    <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>
-    
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="CBD.src.CBD module" href="CBD.src.CBD.html" />
-    <link rel="prev" title="CBD package" href="CBD.html" /> 
-  </head><body>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.src.CBD.html" title="CBD.src.CBD module"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="CBD.html" title="CBD package"
-             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" accesskey="U">CBD package</a> &#187;</li> 
-      </ul>
-    </div>  
-
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
-            
-  <div class="section" id="module-CBD.src">
-<span id="cbd-src-package"></span><h1>CBD.src package<a class="headerlink" href="#module-CBD.src" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="submodules">
-<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
-<div class="toctree-wrapper compound">
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="CBD.src.CBD.html">CBD.src.CBD module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="CBD.src.CBDDraw.html">CBD.src.CBDDraw module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="CBD.src.naivelog.html">CBD.src.naivelog module</a></li>
-</ul>
-</div>
-</div>
-</div>
-
-
-          </div>
-        </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-  <h3><a href="index.html">Table of Contents</a></h3>
-  <ul>
-<li><a class="reference internal" href="#">CBD.src package</a><ul>
-<li><a class="reference internal" href="#submodules">Submodules</a></li>
-</ul>
-</li>
-</ul>
-
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="CBD.html"
-                        title="previous chapter">CBD package</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="CBD.src.CBD.html"
-                        title="next chapter">CBD.src.CBD module</a></p>
-<div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
-    <div class="searchformwrapper">
-    <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>
-    </div>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
-        </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="CBD.src.CBD.html" title="CBD.src.CBD module"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="CBD.html" title="CBD package"
-             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li> 
-      </ul>
-    </div>
-    <div class="footer" role="contentinfo">
-        &#169; Copyright 2020, Randy Paredis.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
-    </div>
-  </body>
-</html>

doc/_build/html/CBD.src.naivelog.html

@@ -1,190 +0,0 @@
-
-<!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="X-UA-Compatible" content="IE=Edge" />
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>CBD.src.naivelog module &#8212; CBD Simulation Development Kit  documentation</title>
-    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" type="text/css" href="_static/style.css" />
-    
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
-    <script type="text/javascript" src="_static/language_data.js"></script>
-    <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>
-    
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Converting Draw.io to CBD" href="drawio2cbd.html" />
-    <link rel="prev" title="CBD.src.CBDDraw module" href="CBD.src.CBDDraw.html" /> 
-  </head><body>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="drawio2cbd.html" title="Converting Draw.io to CBD"
-             accesskey="N">next</a> |</li>
-        <li class="right" >
-          <a href="CBD.src.CBDDraw.html" title="CBD.src.CBDDraw module"
-             accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="CBD.src.html" accesskey="U">CBD.src package</a> &#187;</li> 
-      </ul>
-    </div>  
-
-    <div class="document">
-      <div class="documentwrapper">
-        <div class="bodywrapper">
-          <div class="body" role="main">
-            
-  <div class="section" id="module-CBD.src.naivelog">
-<span id="cbd-src-naivelog-module"></span><h1>CBD.src.naivelog module<a class="headerlink" href="#module-CBD.src.naivelog" title="Permalink to this headline">¶</a></h1>
-<dl class="class">
-<dt id="CBD.src.naivelog.Logger">
-<em class="property">class </em><code class="descclassname">CBD.src.naivelog.</code><code class="descname">Logger</code><span class="sig-paren">(</span><em>modulename</em>, <em>level</em>, <em>crashlevel</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.Logger" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<dl class="method">
-<dt id="CBD.src.naivelog.Logger.debug">
-<code class="descname">debug</code><span class="sig-paren">(</span><em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.Logger.debug" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="CBD.src.naivelog.Logger.error">
-<code class="descname">error</code><span class="sig-paren">(</span><em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.Logger.error" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="CBD.src.naivelog.Logger.fatal">
-<code class="descname">fatal</code><span class="sig-paren">(</span><em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.Logger.fatal" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="CBD.src.naivelog.Logger.formatmsg">
-<code class="descname">formatmsg</code><span class="sig-paren">(</span><em>level</em>, <em>mainstr</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.Logger.formatmsg" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="CBD.src.naivelog.Logger.info">
-<code class="descname">info</code><span class="sig-paren">(</span><em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.Logger.info" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="CBD.src.naivelog.Logger.log">
-<code class="descname">log</code><span class="sig-paren">(</span><em>level</em>, <em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.Logger.log" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="CBD.src.naivelog.Logger.setLevel">
-<code class="descname">setLevel</code><span class="sig-paren">(</span><em>level</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.Logger.setLevel" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="CBD.src.naivelog.Logger.warning">
-<code class="descname">warning</code><span class="sig-paren">(</span><em>mainstr</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.Logger.warning" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-</dd></dl>
-
-<dl class="function">
-<dt id="CBD.src.naivelog.getAbstractLogLevel">
-<code class="descclassname">CBD.src.naivelog.</code><code class="descname">getAbstractLogLevel</code><span class="sig-paren">(</span><em>env</em>, <em>default</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.getAbstractLogLevel" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="CBD.src.naivelog.getCrashLevel">
-<code class="descclassname">CBD.src.naivelog.</code><code class="descname">getCrashLevel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.getCrashLevel" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="CBD.src.naivelog.getLogLevel">
-<code class="descclassname">CBD.src.naivelog.</code><code class="descname">getLogLevel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.getLogLevel" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="CBD.src.naivelog.getLogger">
-<code class="descclassname">CBD.src.naivelog.</code><code class="descname">getLogger</code><span class="sig-paren">(</span><em>modulename</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.getLogger" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="CBD.src.naivelog.levelToShortStr">
-<code class="descclassname">CBD.src.naivelog.</code><code class="descname">levelToShortStr</code><span class="sig-paren">(</span><em>lvl</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.levelToShortStr" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="CBD.src.naivelog.levelToStr">
-<code class="descclassname">CBD.src.naivelog.</code><code class="descname">levelToStr</code><span class="sig-paren">(</span><em>lvl</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.levelToStr" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="function">
-<dt id="CBD.src.naivelog.strToLevel">
-<code class="descclassname">CBD.src.naivelog.</code><code class="descname">strToLevel</code><span class="sig-paren">(</span><em>elvl</em><span class="sig-paren">)</span><a class="headerlink" href="#CBD.src.naivelog.strToLevel" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-</div>
-
-
-          </div>
-        </div>
-      </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-  <h4>Previous topic</h4>
-  <p class="topless"><a href="CBD.src.CBDDraw.html"
-                        title="previous chapter">CBD.src.CBDDraw module</a></p>
-  <h4>Next topic</h4>
-  <p class="topless"><a href="drawio2cbd.html"
-                        title="next chapter">Converting Draw.io to CBD</a></p>
-<div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
-    <div class="searchformwrapper">
-    <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>
-    </div>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
-        </div>
-      </div>
-      <div class="clearer"></div>
-    </div>
-    <div class="related" role="navigation" aria-label="related navigation">
-      <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="py-modindex.html" title="Python Module Index"
-             >modules</a> |</li>
-        <li class="right" >
-          <a href="drawio2cbd.html" title="Converting Draw.io to CBD"
-             >next</a> |</li>
-        <li class="right" >
-          <a href="CBD.src.CBDDraw.html" title="CBD.src.CBDDraw module"
-             >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">CBD Simulation Development Kit  documentation</a> &#187;</li>
-          <li class="nav-item nav-item-1"><a href="CBD.html" >CBD package</a> &#187;</li>
-          <li class="nav-item nav-item-2"><a href="CBD.src.html" >CBD.src package</a> &#187;</li> 
-      </ul>
-    </div>
-    <div class="footer" role="contentinfo">
-        &#169; Copyright 2020, Randy Paredis.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
-    </div>
-  </body>
-</html>

doc/_build/html/CBD.util.html

@@ -0,0 +1,444 @@
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>CBD.util module &mdash; CBD Simulation Development Kit  documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+
+  
+  
+    
+
+  
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
+  <link rel="stylesheet" href="_static/style.css" type="text/css" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="CBD.solver module" href="CBD.solver.html" /> 
+
+  
+  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-167094275-1"></script>
+  <script src="_static/js/googleanalytics.min.js"></script>
+  
+  <script src="_static/js/modernizr.min.js"></script>
+
+  <!-- Preload the theme fonts -->
+
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+
+<!-- Preload the katex fonts -->
+
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+<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">
+</head>
+
+<div class="container-fluid header-holder tutorials-header" id="header-holder">
+  <div class="container">
+    <div class="header-container">
+      <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+
+      <div class="main-menu">
+        <ul>
+
+          <li>
+            <div class="ecosystem-dropdown">
+              <a id="dropdownMenuButtonEcosystem" data-toggle="ecosystem-dropdown">
+                Ecosystem
+              </a>
+              <div class="ecosystem-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://alchemy.host">
+                  <span class=dropdown-title>Alchemy</span>
+                  <p>Experiments logging & visualization</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">
+                  <span class=dropdown-title>Catalyst</span>
+                  <p>Accelerated deep learning R&D</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">
+                  <span class=dropdown-title>Reaction</span>
+                  <p>Convenient deep learning models serving</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <div class="projects-dropdown">
+              <a id="dropdownMenuButtonProjects" data-toggle="projects-dropdown">
+                Projects
+              </a>
+              <div class="projects-dropdown-menu">
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">
+                  <span class=dropdown-title>Codestyle</span>
+                  <p>Joint R&D codestyle</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">
+                  <span class=dropdown-title>Catalyst.Neuro</span>
+                  <p>Catalyst.Team and TReNDS collaborative project</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">
+                  <span class=dropdown-title>Classification</span>
+                  <p>Image classification pipeline with transfer learning</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">
+                  <span class=dropdown-title>Detection</span>
+                  <p>Object detection pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">
+                  <span class=dropdown-title>Segmentation</span>
+                  <p>Image semantic segmentation pipeline</p>
+                </a>
+                <a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">
+                  <span class=dropdown-title>Catalyst.GAN</span>
+                  <p>GAN pipelines</p>
+                </a>
+              </div>
+            </div>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/dl-course">Deep learning course</a>
+          </li>
+        </ul>
+      </div>
+
+      <a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
+    </div>
+
+  </div>
+</div>
+
+
+<body class="catalyst-body">
+
+   
+
+    
+
+    <div class="table-of-contents-link-wrapper">
+      <span>Table of Contents</span>
+      <a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
+    </div>
+
+    <nav data-toggle="wy-nav-shift" class="catalyst-left-menu" id="catalyst-left-menu">
+      <div class="catalyst-side-scroll">
+        <div class="catalyst-menu catalyst-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          <div class="catalyst-left-menu-search">
+            
+
+            
+              
+              
+            
+
+            
+
+
+  
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search Docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+            
+          </div>
+
+          
+            
+            
+              
+            
+            
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="CBD.html">CBD package</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <div class="catalyst-container">
+      <div class="catalyst-page-level-bar" id="catalyst-page-level-bar">
+        <div class="catalyst-breadcrumbs-wrapper">
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="catalyst-breadcrumbs">
+    
+      <li>
+        <a href="index.html">
+          
+            Docs
+          
+        </a> &gt;
+      </li>
+
+        
+          <li><a href="CBD.html">CBD package</a> &gt;</li>
+        
+      <li>CBD.util module</li>
+    
+    
+      <li class="catalyst-breadcrumbs-aside">
+        
+            
+        
+      </li>
+    
+  </ul>
+
+  
+</div>
+        </div>
+
+        <div class="catalyst-shortcuts-wrapper" id="catalyst-shortcuts-wrapper">
+          Shortcuts
+        </div>
+      </div>
+
+      <section data-toggle="wy-nav-shift" id="catalyst-content-wrap" class="catalyst-content-wrap">
+        <div class="catalyst-content-left">
+          
+          <div class="rst-content">
+          
+            <div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
+             <article itemprop="articleBody" id="catalyst-article" class="catalyst-article">
+              
+  <div class="section" id="module-CBD.util">
+<span id="cbd-util-module"></span><h1>CBD.util module<a class="headerlink" href="#module-CBD.util" title="Permalink to this headline">¶</a></h1>
+<dl class="data">
+<dt id="CBD.util.PYTHON_VERSION">
+<code class="descclassname">CBD.util.</code><code class="descname">PYTHON_VERSION</code><em class="property"> = 3</em><a class="headerlink" href="#CBD.util.PYTHON_VERSION" title="Permalink to this definition">¶</a></dt>
+<dd><p>The python version of the simulation.</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="CBD.util.enum">
+<code class="descclassname">CBD.util.</code><code class="descname">enum</code><span class="sig-paren">(</span><em>**enums</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/CBD/util.html#enum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#CBD.util.enum" title="Permalink to this definition">¶</a></dt>
+<dd><p>Helper function to construct simple enums.</p>
+</dd></dl>
+
+</div>
+
+
+             </article>
+             
+            </div>
+            <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+      
+        <a href="CBD.solver.html" class="btn btn-neutral" title="CBD.solver module" accesskey="p" rel="prev"><img src="_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>
+      
+    </div>
+  
+
+  <hr>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Randy Paredis.
+
+    </p>
+  </div>
+    
+      <div>
+        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>.
+      </div>
+     
+
+</footer>
+
+          </div>
+        </div>
+
+        <div class="catalyst-content-right" id="catalyst-content-right">
+          <div class="catalyst-right-menu" id="catalyst-right-menu">
+            <div class="catalyst-side-scroll" id="catalyst-side-scroll-right">
+              <ul>
+<li><a class="reference internal" href="#">CBD.util module</a></li>
+</ul>
+
+            </div>
+          </div>
+        </div>
+      </section>
+    </div>
+
+  
+
+
+  
+
+     
+       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
+         <script type="text/javascript" src="_static/language_data.js"></script>
+     
+
+  
+
+  <script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
+  <script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+  <!-- Begin Footer -->
+
+  <footer class="site-footer" id="site-footer">
+    <div class="container footer-container">
+      <div class="footer-logo-wrapper">
+        <a href="https://catalyst-team.com/" class="footer-logo"></a>
+      </div>
+
+      <div class="footer-links-wrapper">
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Ecosystem</a></li>
+            <li><a class="nav-dropdown-item" href="https://alchemy.host">Alchemy</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/catalyst">Catalyst</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/reaction">Reaction</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://github.com/catalyst-team">Projects</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/codestyle">Codestyle</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/neuro">Catalyst.Neuro</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/classification">Classification</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/detection">Detection</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/segmentation">Segmentation</a></li>
+            <li><a class="nav-dropdown-item" href="https://github.com/catalyst-team/gan">Catalyst.GAN</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col">
+          <ul>
+            <li class="list-title"><a href="https://catalyst-team.com/">Support</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/issues" target="_blank">Github Issues</a></li>
+            <li><a href="https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
+            <li><a href="https://www.patreon.com/catalyst_team" target="_blank">Patreon</a></li>
+          </ul>
+        </div>
+
+        <div class="footer-links-col follow-us-col">
+          <div class="footer-social-icons">
+            <a href="https://t.me/catalyst_team" target="_blank" class="telegram"></a>
+            <a href="https://twitter.com/catalyst_core" target="_blank" class="twitter"></a>
+            <a href="https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw" target="_blank" class="ods"></a>
+          </div>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+
+  <!-- End Footer -->
+
+  <!-- Begin Mobile Menu -->
+
+  <div class="mobile-main-menu">
+    <div class="container-fluid">
+      <div class="container">
+        <div class="mobile-main-menu-header-container">
+          <a class="header-logo" href="https://catalyst-team.com/" aria-label="Catalyst"></a>
+          <a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
+        </div>
+      </div>
+    </div>
+
+    <div class="mobile-main-menu-links-container">
+      <div class="main-menu">
+        <ul>
+          <li>
+            <a href="">Get Started</a>
+          </li>
+
+          <li>
+            <a href="https://github.com/catalyst-team/catalyst">Github</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+
+  <!-- End Mobile Menu -->
+
+  <script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      mobileMenu.bind();
+      mobileTOC.bind();
+      catalystAnchors.bind();
+      sideMenus.bind();
+      scrollToAnchor.bind();
+      highlightNavigation.bind();
+      mainMenuDropdown.bind();
+
+      // Add class to links that have code blocks, since we cannot create links in code blocks
+      $("article.catalyst-article a span.pre").each(function(e) {
+        $(this).closest("a").addClass("has-code");
+      });
+    })
+  </script>
+</body>
+</html>

doc/_build/html/_downloads/a57d22c7f1597349da5657d50f4b0a70/drawio2cbd.py

@@ -1,437 +0,0 @@
-"""This script generates a Python-consistent CBD from an XML file, as
-constructed in draw.io / diagrams.net .
-
-:Author: 			Randy Paredis
-:Python Version:	3.6+
-"""
-
-import xml.etree.ElementTree as ET
-import argparse
-from urllib.parse import unquote
-import zlib
-import base64
-import re
-import warnings
-
-IGNORE = ['id', 'label', 'placeholders', 'symbol', 'class_name', 'block_name', '__docstring__']
-"""Properties to ignore when parsing."""
-
-PLOT_FORMATS = ['mpl', 'matplotlib', 'bokeh', 'csv', 'off', 'false']
-"""Ways to plot the data."""
-
-class Parser:
-	"""Parses a draw.io XML file.
-
-	Args:
-		inputfile (str):	Filename for the input.
-		outputfile (str):	When a string, this is the output filename.
-							When None, the console will be used.
-		all_ (bool):		Whether or not to add empty CBD diagrams to the
-							generated file.
-		ports (bool):		Some port names can be identified from the context.
-							By default, the generated code allows the CBD framework
-							to do so. When this param is True, even those ports will
-							explicitly be set.
-	"""
-	def __init__(self, inputfile, outputfile=None, all_=False, ports=False):
-		self.inputfile = inputfile
-		self.outputfile = outputfile
-		self.all_ = all_
-		self.ports = ports
-		self.__block_names = {}
-		self.__signals = {}
-
-	@staticmethod
-	def decode_and_deflate(data):
-		"""Draw.io compresses each page as follows:
-		First, all data is url-encoded
-		Next, it is compressed/deflated
-		Finally, it is encoded according to base64.
-
-		To obtain the page data, we have to do the reverse.
-
-		Returns:
-			Uncompressed and decoded data as a string.
-		"""
-		decoded_data = base64.b64decode(data)
-		inflated = zlib.decompress(decoded_data, -15).decode('utf-8')
-		url_decoded_data = unquote(inflated)
-		return ET.fromstring(url_decoded_data)
-		
-	def parse(self):
-		"""Does the actual file parsing.
-
-		If the file is compressed, we uncompress and work from there.
-		If it wasn't compressed, we can work with the whole tree.
-
-		Only looks at "Custom Class" shapes that have a "class_name"
-		set.
-
-		Returns:
-		 	An iterator of all classes that must be generated.
-		"""
-		tree = ET.parse(self.inputfile)
-		root = tree.getroot()
-		compressed = len(root.findall(".//mxGraphModel")) == 0
-		if compressed:
-			# If compressed, first decode base64, then deflate, then url decode
-			pages = root.findall(".//diagram")
-			for page in pages: # Decoding happens pagewise
-				nroot = self.decode_and_deflate(page.text)
-				objects = nroot.findall(".//object/mxCell/mxGeometry/mxRectangle/../../..[@class_name]")
-				for obj in objects:
-					yield self.create_class(nroot, **obj.attrib)
-		else:
-			objects = root.findall(".//object/mxCell/mxGeometry/mxRectangle/../../..[@class_name]")
-			for obj in objects:
-				yield self.create_class(root, **obj.attrib)
-			
-	def create_class(self, root, class_name, **kwargs):
-		"""Creates a class.
-
-		Args:
-			root:				The root element for this class. Must be the document.
-								Is used to find links with other classes.
-			class_name (str):	The name for the class.
-			**kwargs:			Additional class parameters as set in the Properties window.
-
-		Returns:
-		 	A class as a string.
-		"""
-		if class_name in self.__block_names:
-			raise ParseException(f"Class '{class_name}' already defined.")
-		if re.search(r"\s", class_name) is not None:
-			raise ParseException(f"In class '{class_name}': Class names may not contain spaces.")
-		self.__block_names[class_name] = kwargs.get("block_name", class_name)
-		if self.__block_names[class_name] is None or self.__block_names[class_name] == "":
-			self.__block_names[class_name] = class_name
-		rect = root.findall(".//*[@parent='%s']" % kwargs["id"])[1]
-		components = root.findall(".//object/mxCell[@parent='%s']/.." % rect.attrib["id"])
-		inputs = []
-		outputs = []
-		blocks = []
-		lookup = {}
-		__added = set()
-		for com in components:
-			att = com.attrib
-			if att["class_name"] == "InputPortBlock":
-				name = att["name"]
-				if name in __added:
-					raise ParseException(f"In class '{class_name}': Block or port with name '{name}' already exists.")
-				__added.add(name)
-				inputs.append(name)
-				lookup[att["id"]] = name
-			elif att["class_name"] == "OutputPortBlock":
-				name = att["name"]
-				if name in __added:
-					raise ParseException(f"In class '{class_name}': Block or port with name '{name}' already exists.")
-				__added.add(name)
-				outputs.append(name)
-				lookup[att["id"]] = name
-				if "signal" in att and att["signal"] != "":
-					self.__signals.setdefault(class_name, {}).setdefault(att["signal"], []).append(name)
-			else:
-				block_name = att.get("block_name", att["id"])
-				if block_name == '':
-					block_name = att['id']
-				if block_name in __added:
-					raise ParseException(f"In class '{class_name}': Block or port with name '{block_name}' already exists.")
-				__added.add(block_name)
-				lookup[att["id"]] = block_name
-				if any(["\n" in v for v in att.values()]):
-					raise ParseException(f"In class '{class_name}', block '{block_name}' ({att['class_name']}): Block properties should not contain newlines!")
-				blocks.append("self.addBlock(%s(%s))" % (att["class_name"],
-					", ".join(["block_name='%s'" % block_name] + \
-							  [f"{k}=({v.strip() if v != '' else None})" for k, v in att.items() if k not in IGNORE])))
-		blocks = f"\n{TABS}{TABS}".join(blocks)
-			
-		edges = root.findall(".//*[@parent='%s'][@edge='1']" % rect.attrib["id"])
-		connections = []
-		for edge in edges:
-			att = edge.attrib
-			source = root.find(".//*[@id='%s']" % att["source"])
-			target = root.find(".//*[@id='%s']" % att["target"])
-			if source.attrib["class_name"] == "InputPortBlock":
-				sblock = source.attrib["name"]
-				ipn = ""
-			else:
-				sblock = lookup[source[0].attrib["parent"]]
-				if not self.ports and source.attrib["name"] == "OUT1":
-					ipn = ""
-				else:
-					ipn = source.attrib["name"]
-			if target.attrib["class_name"] == "OutputPortBlock":
-				tblock = target.attrib["name"]
-				opn = ""
-			else:
-				tblock = lookup[target[0].attrib["parent"]]
-				if not self.ports and re.match(r"IN\d+", target.attrib["name"]):
-					opn = ""
-				else:
-					opn = target.attrib["name"]
-			conn = "self.addConnection('%s', '%s'" % (sblock, tblock)
-			if opn != "":
-				conn += ", input_port_name='%s'" % opn
-			if ipn != "":
-				conn += ", output_port_name='%s'" % ipn
-			conn += ")"
-			connections.append(conn)
-		connections = f"\n{TABS}{TABS}".join(connections)
-
-		if not self.all_ and connections == "" and blocks == "":
-			return ""
-
-		docstring = kwargs.get("__docstring__", "")
-		if docstring != "":
-			docstring = f'\n{TABS}"""{docstring}"""'
-		if any(["\n" in v for k, v in kwargs.items() if k != '__docstrig__']):
-			raise ParseException(f"In class '{class_name}': Properties should not contain newlines!")
-		kv = ", ".join([""] + [f"{k}=({v.strip() if v != '' else None})" for k, v in kwargs.items() if k not in IGNORE])
-		return f"""
-class {class_name}(CBD):{docstring}
-{TABS}def __init__(self, block_name{kv}):
-{TABS}{TABS}CBD.__init__(self, block_name, input_ports={inputs}, output_ports={outputs})
-		
-{TABS}{TABS}# Create the blocks
-{TABS}{TABS}{blocks}
-		
-{TABS}{TABS}# Connect the blocks
-{TABS}{TABS}{connections}
-"""
-
-	def create_file(self, command, entry='main', delta=None, time=10, draw=None, latex=None, plot=None):
-		"""Creates the full file.
-
-		Args:
-			command (str):	The command that was used to run this script.
-			entry (str):	The main class entry point.
-			delta (float):	The timestep size. This is 1 for Discrete-Time CBDs.
-			time (int):		How long the simulation should run.
-			draw:			List of blocks to draw. None indicates the empty list.
-			latex:			List of blocks to generate LaTeX for. None indicates the empty list.
-			plot (str):		The plotting format to use. None indicates no plotting.
-
-		Returns:
-		 	The file as a string.
-		"""
-		# Check which blocks to draw
-		draw_import = ""
-		draw_func = ""
-		if draw is not None:
-			draw_import = "\nfrom CBD.src.CBDDraw import draw"
-			if len(draw) > 1:
-				draw_func = f"""
-{TABS}# Draw the CBDs
-{TABS}for to_draw in {draw}:
-{TABS}{TABS}block, path = cbd.findBlock(to_draw)
-{TABS}{TABS}draw(block, '%s.gv' % path)"""
-			else:
-				if draw[0] == '':
-					draw_func = f"\n{TABS}# Draw the CBD\n{TABS}draw(cbd, '%s.gv' % cbd.getBlockName())"
-				else:
-					draw_func = f"\n{TABS}# Draw the CBD\n{TABS}draw(cbd.findBlock('{draw[0]}')[0], '{draw[0]}.gv')"
-
-		# Check which blocks to generate LaTeX for
-		latex_func = ""
-		if latex is not None:
-			if len(latex) > 1:
-				latex_func = f"""
-
-{TABS}# Print the CBDs as LaTeX
-{TABS}for to_tex in {latex}:
-{TABS}{TABS}block, path = cbd.findBlock(to_tex)
-{TABS}{TABS}print("LaTeX for '%s':" % path)
-{TABS}{TABS}print(block.latex(), '\\n')"""
-			else:
-				if latex[0] == '':
-					latex_func = f"""
-
-{TABS}# Print the CBD as LaTeX
-{TABS}print("LaTeX for '%s':" % cbd.getBlockName())
-{TABS}print(cbd.latex(), '\\n')"""
-				else:
-					latex_func = f"""
-
-{TABS}# Print the CBD as LaTeX
-{TABS}print("LaTeX for '{latex[0]}':")
-{TABS}print(gcbd.findBlock('{latex[0]}')[0].latex(), '\\n')"""
-
-		# Actual class creation
-		cls = "\n".join(self.parse())
-
-		# Signal info
-		signals = f"\n{TABS}# TODO: process your results"
-		sig_fnc = ""
-		if plot is not None and plot not in ['off', 'false']:
-			if entry in self.__signals:
-				signals = ""
-				for title, sgs in self.__signals[entry].items():
-					signals += f"\n{TABS}plot_signals(cbd, {sgs}, '{title}')"
-				sig_fnc = self.signal(plot, delta is not None)
-
-		# Set times:
-		_delta = ""
-		run = f"cbd.run({time})"
-		if delta is not None:
-			_delta = f"{TABS}DELTA_T = {delta}\n\n"
-			run = f"cbd.run({time}, delta_t=DELTA_T)"
-
-		# Actual file construction
-		return f"""#!/usr/bin/python3
-# This file was automatically generated from drawio2cbd with the command:
-#   {command}
-
-from CBD.src.CBD import *{draw_import}
-{sig_fnc}
-
-{cls}
-
-if __name__ == '__main__':
-{_delta}{TABS}cbd = {entry}("{self.__block_names.get(entry, 'root')}")
-{draw_func}{latex_func}
-
-{TABS}# Run the simulation
-{TABS}{run}
-
-{TABS}# process simulation results{signals}
-"""
-
-	@staticmethod
-	def signal(format:str, ct=False):
-		"""Creates a draw_signals function and corresponing imports, based on
-		the given format. Accepted formats are 'matplotlib' (or 'mpl' for short),
-		'bokeh' and 'csv'.
-
-		Args:
-			format (str):	How the signal must be outputted.
-							Can be one of ['matplotlib', 'mpl', 'bokeh', 'csv']
-			ct (bool): 		Whether or not the plot indicates a continuous-time
-							simulation. When it does, a line-plot will be used
-							for the plots, otherwise a dotted plot is used. For
-							CSV and XML this attribute has no effect.
-							Defaults to 'False'.
-
-		Returns:
-			A string, including a 'plot_signal' function for the generated file.
-		"""
-		assert format in PLOT_FORMATS
-		imports = ""
-		plot = ""
-
-		if format in ['matplotlib', 'mpl']:
-			imports = """
-import matplotlib.pyplot as plt
-"""
-			plot = f"""
-{TABS}plt.figure()
-{TABS}plt.title(title)
-{TABS}plt.xlabel('time')
-{TABS}plt.ylabel('N')
-{TABS}for i in range(len(signals)):
-{TABS}{TABS}plt.{'plot' if ct else 'scatter'}(times, outputs[i], label=signals[i])
-{TABS}plt.legend()
-{TABS}plt.show()
-"""
-
-		elif format == 'bokeh':
-			imports = """
-from bokeh.plotting import figure, output_file, show
-from bokeh.palettes import Dark2_5 as palette
-import itertools
-"""
-			plot = f"""
-{TABS}colors = itertools.cycle(palette) 
-{TABS}output_file("%s.html" % title.replace(' ', '_').lower(), title=title)
-{TABS}p = figure(title=title, x_axis_label='time', y_axis_label='N')
-{TABS}for i in range(len(signals)):
-{TABS}{TABS}p.{'line' if ct else 'circle'}(x=times, y=outputs[i], legend_label=signals[i], color=next(colors))
-{TABS}show(p)
-"""
-
-		elif format == 'csv':
-			plot = f"""
-{TABS}with open("%s.csv" % title.replace(' ', '_').lower(), 'w') as file:
-{TABS}{TABS}file.write('time, %s' % ', '.join(signals))
-{TABS}{TABS}for i in range(len(times)):
-{TABS}{TABS}{TABS}file.write(f'\\n{{times[i]}}, %s' % ', '.join([str(o[i]) for o in outputs]))
-"""
-		try:
-			exec(imports)
-		except ImportError as e:
-			warnings.warn(f"Cannot find plotting framework '{format}' ({str(e)}); use one of {PLOT_FORMATS}.", UserWarning)
-
-		return f"""
-{imports}
-
-def plot_signals(block, signals, title):
-{TABS}times = []
-{TABS}outputs = []
-
-{TABS}for signal in signals:
-{TABS}{TABS}tvpl = block.getSignal(signal)
-{TABS}{TABS}times = [t for t, _ in tvpl]
-{TABS}{TABS}outputs.append([v for _, v in tvpl])
-
-{TABS}# Plot{plot}
-"""
-
-	def convert(self, command, entry='main', delta=None, time=10, draw=None, latex=None, plot=None):
-		"""Does the conversion and creates a file or prints to the console.
-
-		Args:
-			command (str):	The command that was used to run this script.
-			entry (str):	The main class entry point.
-			delta (float):	The timestep size. This is 1 for Discrete-Time CBDs.
-			time (int):		How long the simulation should run.
-			draw:			List of blocks to draw. None indicates the empty list.
-			latex:			List of blocks to generate LaTeX for. None indicates the empty list.
-			plot (str):		The plotting format to use. None indicates no plotting.
-		"""
-		contents = self.create_file(command, entry, delta, time, draw, latex, plot)
-		if self.outputfile is None:
-			print(contents)
-		else:
-			with open(self.outputfile, 'w') as file:
-				file.write(contents)
-
-
-class ParseException(Exception):
-	"""Semantic exceptions when parsing."""
-	def __init__(self, message):
-		super().__init__(message)
-
-if __name__ == '__main__':
-	from sys import argv
-
-	argprs = argparse.ArgumentParser(description='Create Python3 CBD simulations from draw.io/diagrams.net XML files.')
-	argprs.add_argument('input', type=str,
-						help="the input file to convert")
-	argprs.add_argument('output', type=str, default=None, nargs='?',
-						help="an optional output file; when omitted, it will be printed to the console")
-	argprs.add_argument("-e", "--entry", required=True,
-						help="the main CBD to use as a simulation entrypoint")
-	argprs.add_argument("-T", "--delta", default=None, type=float,
-						help="timestep of the simulation; used for continuous-time CBDs (default: 1.0)")
-	argprs.add_argument("-t", "--time", default=10, type=int,
-						help="total simulation time steps to take (default: 10)")
-	# argprs.add_argument("-d", "--draw", action='append', nargs='?', const='',
-	# 					help="makes it so the script draws a Graphviz model for the given CBD path "
-	# 						 "(use '.' as path separator)")
-	# argprs.add_argument("-l", "--latex", action='append', nargs='?', const='',
-	# 					help="outputs LaTeX code for the block (use '.' as path separator)")
-	argprs.add_argument('-P', '--plot', choices=PLOT_FORMATS, default='mpl',
-						help="sets plotter to use in generated script")
-	argprs.add_argument('-a', '--all', action='store_true',
-						help="when set, empty CBDs will be created as a class, otherwise they are ignored")
-	argprs.add_argument('-p', '--ports', action='store_true',
-						help="when set, even the default ports will be explicitly set")
-	argprs.add_argument('-s', '--spaces', type=int, default=0,
-						help="when set larger than 0, this amount of spaces will be used instead of tabs (default: 0)")
-	args = argprs.parse_args()
-	TABS = "\t"
-	if args.spaces > 0:
-		TABS = " " * args.spaces
-	parser = Parser(args.input, args.output, args.all, args.ports)
-	parser.convert(" ".join(argv), args.entry, args.delta, args.time, None, None, args.plot)
-	
-