Changed name to pyCBD

doc/CBD.Core.rst

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

doc/CBD.converters.latexify.CBD2Latex.rst

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

doc/CBD.converters.latexify.functions.rst

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

doc/CBD.converters.rst

@@ -1,19 +0,0 @@
-CBD.converters
-==============
-
-.. automodule:: CBD.converters
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
-
-   CBD.converters.eq2CBD
-   CBD.converters.latexify
-   CBD.converters.CBD2C
-   CBD.converters.CBDDraw
-   CBD.converters.hybrid
-

doc/CBD.depGraph.rst

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

doc/CBD.lib.endpoints.rst

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

doc/CBD.lib.io.rst

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

doc/CBD.lib.std.rst

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

doc/CBD.loopsolvers.rst

@@ -1,13 +0,0 @@
-CBD.loopsolvers module
-======================
-
-.. automodule:: CBD.loopsolvers
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-.. toctree::
-
-   CBD.loopsolvers.solver
-   CBD.loopsolvers.linearsolver
-   CBD.loopsolvers.sympysolver

doc/CBD.loopsolvers.solver.rst

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

doc/CBD.naivelog.rst

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

doc/CBD.preprocessing.butcher.rst

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

doc/CBD.preprocessing.rungekutta.rst

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

doc/CBD.realtime.accurate_time.rst

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

doc/CBD.realtime.plotting.rst

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

doc/CBD.realtime.rst

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

doc/CBD.realtime.threadingGameLoopAlt.rst

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

doc/CBD.realtime.threadingPython.rst

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

doc/CBD.realtime.threadingTkInter.rst

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

doc/CBD.rst

@@ -1,33 +0,0 @@
-CBD package
-===========
-
-.. automodule:: CBD
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
-
-    CBD.lib
-    CBD.realtime
-    CBD.tracers
-    CBD.converters
-    CBD.loopsolvers
-    CBD.state_events
-    CBD.preprocessing
-
-Submodules
-----------
-
-.. toctree::
-
-   CBD.Core
-   CBD.depGraph
-   CBD.naivelog
-   CBD.scheduling
-   CBD.simulator
-   CBD.util
-

doc/CBD.state_events.locators.rst

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

doc/CBD.state_events.rst

@@ -1,15 +0,0 @@
-CBD.state_events module
-=======================
-
-.. automodule:: CBD.state_events
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
-
-   CBD.state_events.locators
-

doc/CBD.tracers.baseTracer.rst

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

doc/CBD.tracers.color.rst

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

doc/CBD.tracers.rst

@@ -1,17 +0,0 @@
-CBD.tracers package
-===================
-
-.. automodule:: CBD.tracers
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
-
-   CBD.tracers.color
-   CBD.tracers.baseTracer
-   CBD.tracers.tracerVerbose
-

doc/CBD.tracers.tracerVerbose.rst

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

doc/CBD.util.rst

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

doc/changelog.rst

@@ -4,6 +4,7 @@ Changelog
 .. code-block:: text
 
     Version 1.5
+        * Changed project name from CBD to pyCBD
         * Changed how ports work. Instead of using PortBlocks, a custom Port
           (and Connection) class has been introduced.
             - InputPortBlock, WireBlock and OutputPortBlock were removed.

doc/conf.py

@@ -20,7 +20,7 @@ sys.path.insert(0, os.path.abspath('..'))
 
 # -- Project information -----------------------------------------------------
 
-project = 'CBD Simulator'
+project = 'pyCBD Simulator'
 copyright = '2020, Randy Paredis'
 author = 'Randy Paredis'
 
@@ -124,7 +124,7 @@ html_show_sourcelink = False
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'cbddoc'
+htmlhelp_basename = 'pycbddoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -151,7 +151,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'cbd.tex', 'CBD Documentation',
+    (master_doc, 'pyCBD.tex', 'pyCBD Documentation',
      'Randy Paredis', 'manual'),
 ]
 
@@ -161,7 +161,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'cbd', 'cbd Documentation',
+    (master_doc, 'pyCBD', 'pyCBD Documentation',
      [author], 1)
 ]
 
@@ -172,8 +172,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'cbd', 'cbd Documentation',
-     author, 'cbd', 'One line description of project.',
+    (master_doc, 'pyCBD', 'pyCBD Documentation',
+     author, 'pyCBD', 'One line description of project.',
      'Miscellaneous'),
 ]
 

doc/index.rst

@@ -1,13 +1,13 @@
 .. Copyright the Modelling, Simulation and Design Lab (MSDL)
-      http://msdl.cs.mcgill.ca/
+      http://msdl.uantwerpen.be/
 
 .. drawio2cbd documentation master file, created by
    sphinx-quickstart on Mon Oct 19 12:31:01 2020.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to the CBD Simulator's Documentation!
-=============================================
+Welcome to the pyCBD Simulator's Documentation!
+===============================================
 
 This package contains a CBD modelling and simulation framework, which can be used
 to model complex systems of equations.
@@ -55,11 +55,11 @@ to model complex systems of equations.
     examples/RealTime
     examples/LivePlot
     examples/Dashboard
-    CBD.converters.latexify
+    pyCBD.converters.latexify
     examples/ContinuousTime
 
 .. toctree::
     :maxdepth: 3
     :caption: Internal Documentation
 
-    CBD
+    pyCBD

doc/install.rst

@@ -1,5 +1,5 @@
-How to install the CBD framework?
-=================================
+How to install the pyCBD framework?
+===================================
 This section describes the necessary components and steps to take to install
 the CBD framework.
 
@@ -30,9 +30,9 @@ Next, there are some additional **optional** requirements:
 
 * **Conversion:**
 
-  * `Lark <https://lark-parser.readthedocs.io/en/latest/>`_ for the :mod:`CBD.converters.eq2CBD` converter, to
+  * `Lark <https://lark-parser.readthedocs.io/en/latest/>`_ for the :mod:`pyCBD.converters.eq2CBD` converter, to
     allow the creation of CBDs directly from a textual language.
-  * `PythonPDEVS <http://msdl.cs.mcgill.ca/projects/DEVS/PythonPDEVS>`_ for the :mod:`CBD.converters.hybrid`
+  * `PythonPDEVS <http://msdl.cs.mcgill.ca/projects/DEVS/PythonPDEVS>`_ for the :mod:`pyCBD.converters.hybrid`
     module. This allows CBDs to be run inside of DEVS simulations.
 
 * **Documentation:**
@@ -43,14 +43,14 @@ Installation
 ------------
 There are a few ways of using the framework:
 
-#. Use it as a project dependency. Simply add the :code:`src/CBD` folder to your project and
+#. Use it as a project dependency. Simply add the :code:`src/pyCBD` folder to your project and
    import it w.r.t. the provided path.
 #. Edit the :code:`PYTHONPATH` or :code:`sys.path` variables to point to the :code:`src` folder.
    This way, the execution of your program will recognize things like:
 
    .. code-block:: python
 
-      from CBD.Core import CBD
+      from pyCBD.Core import CBD
 
    .. tip::
         Some code editors (like `PyCharm <https://www.jetbrains.com/pycharm/>`_) allow you to mark
@@ -75,6 +75,6 @@ the framework, but can technically be used without the connection to CBDs. These
 .. toctree::
     :maxdepth: 3
 
-    CBD.util
-    CBD.naivelog
-    CBD.realtime
+    pyCBD.util
+    pyCBD.naivelog
+    pyCBD.realtime

doc/issues.rst

@@ -7,13 +7,13 @@ most common exceptions and/or issues are shown.
 AssertionError: Can only add BaseBlock (subclass) instances to a CBD
 --------------------------------------------------------------------
 This error is thrown whenever you try adding a block using the
-:func:`CBD.Core.CBD.addBlock` function if that block does **not** inherit from
-the :class:`CBD.Core.BaseBlock` class.
+:func:`pyCBD.Core.CBD.addBlock` function if that block does **not** inherit from
+the :class:`pyCBD.Core.BaseBlock` class.
 
 NotImplementedError: BaseBlock has nothing to compute
 -----------------------------------------------------
-When invalidly inheriting a :class:`CBD.Core.BaseBlock`, this error may occur.
-It is a consequence of not overwriting the :func:`CBD.Core.BaseBlock.compute`
+When invalidly inheriting a :class:`pyCBD.Core.BaseBlock`, this error may occur.
+It is a consequence of not overwriting the :func:`pyCBD.Core.BaseBlock.compute`
 method.
 
 ValueError: Specified object/influencer/dependent is not member of this graph
@@ -21,7 +21,7 @@ ValueError: Specified object/influencer/dependent is not member of this graph
 This issue is indicative of an error in the dependency graph construction. Usually,
 this is due to an invalid connection between blocks. Make sure to always connect
 blocks that have been added to the CBD model. I.e. always call
-:func:`CBD.Core.CBD.addBlock` **before** any :func:`CBD.Core.CBD.addConnection`
+:func:`pyCBD.Core.CBD.addBlock` **before** any :func:`pyCBD.Core.CBD.addConnection`
 that includes the same block.
 
 KeyError: 'X'
@@ -33,21 +33,21 @@ Cannot solve non-linear algebraic loop.
 ---------------------------------------
 The internal solver of the CBD simulator is a simple `Gaussian-Jordan Linear solver
 <https://en.wikipedia.org/wiki/Gaussian_elimination>`_
-(see :class:`CBD.solver.GaussianJordanLinearSolver`) that uses row reduction to solve
+(see :class:`pyCBD.solver.GaussianJordanLinearSolver`) that uses row reduction to solve
 the algebraic loop. However, if this loop represents a non-linear system, the solver
-cannot handle this. Make use of a :class:`CBD.lib.std.DelayBlock` to actively "break"
+cannot handle this. Make use of a :class:`pyCBD.lib.std.DelayBlock` to actively "break"
 the loop.
 
-**Hint:** Internally, the :class:`CBD.lib.std.DerivatorBlock` and the
-:class:`CBD.lib.std.IntegratorBlock` make use of a :class:`CBD.lib.std.DelayBlock`, hence
+**Hint:** Internally, the :class:`pyCBD.lib.std.DerivatorBlock` and the
+:class:`pyCBD.lib.std.IntegratorBlock` make use of a :class:`pyCBD.lib.std.DelayBlock`, hence
 they can be used to solve the issue.
 
 Warning: did not add this block as it has the same name X as an already existing block
 --------------------------------------------------------------------------------------
-A warning that's generated by the :func:`CBD.Core.CBD.addBlock` method if it shares the
+A warning that's generated by the :func:`pyCBD.Core.CBD.addBlock` method if it shares the
 same name as an already existing block. This is meant to ensure uniqueness of names.
 
-ImportError: cannot import name 'Clock' from partially initialized module 'CBD.lib.std'
----------------------------------------------------------------------------------------
-Before importing the standard library, it is important to also import the :mod:`CBD.Core`
+ImportError: cannot import name 'Clock' from partially initialized module 'pyCBD.lib.std'
+-----------------------------------------------------------------------------------------
+Before importing the standard library, it is important to also import the :mod:`pyCBD.Core`
 module. This will solve the circular dependency and dissipate the error.

doc/pyCBD.Core.rst

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

doc/CBD.converters.CBDDraw.rst

@@ -1,7 +1,7 @@
 Generate GraphViz from CBD Models
 =================================
 
-.. automodule:: CBD.converters.CBDDraw
+.. automodule:: pyCBD.converters.CBDDraw
     :members:
     :undoc-members:
     :show-inheritance:

doc/CBD.converters.eq2CBD.rst

@@ -1,7 +1,7 @@
 Generate CBD Models from Equations
 ==================================
 
-.. automodule:: CBD.converters.eq2CBD
+.. automodule:: pyCBD.converters.eq2CBD
     :members:
     :undoc-members:
     :show-inheritance:

doc/CBD.converters.hybrid.rst

@@ -1,7 +1,7 @@
 Encapsulating CBD Models in PythonPDEVS
 =======================================
 
-.. automodule:: CBD.converters.hybrid
+.. automodule:: pyCBD.converters.hybrid
     :members:
     :undoc-members:
     :show-inheritance:

doc/pyCBD.converters.latexify.CBD2Latex.rst

@@ -0,0 +1,7 @@
+pyCBD.converters.latexify.CBD2Latex module
+==========================================
+
+.. automodule:: pyCBD.converters.latexify.CBD2Latex
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/pyCBD.converters.latexify.functions.rst

@@ -0,0 +1,7 @@
+pyCBD.converters.latexify.functions module
+==========================================
+
+.. automodule:: pyCBD.converters.latexify.functions
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/CBD.converters.latexify.rst

@@ -12,7 +12,7 @@ plaintext, or in LaTeX format.
 As an example, the :doc:`examples/SinGen` will be used. It will be assumed the
 :class:`SinGen` class exists and a CBD model is created for this class, stored in the
 :code:`model` variable.
-Additionally, it is important to import the :class:`CBD.converters.latexify.CBD2Latex` class:
+Additionally, it is important to import the :class:`pyCBD.converters.latexify.CBD2Latex` class:
 
 .. code-block:: python
 
@@ -20,12 +20,12 @@ Additionally, it is important to import the :class:`CBD.converters.latexify.CBD2
     model = SinGen('model')
 
     # Import the latexify core unit
-    from CBD.converters.latexify import CBD2Latex
+    from pyCBD.converters.latexify import CBD2Latex
     # OR, ALTERNATIVELY
-    from CBD.converters.latexify.CBD2Latex import CBD2Latex
+    from pyCBD.converters.latexify.CBD2Latex import CBD2Latex
 
 Next, we will create a converter, which can tell us the system of equations. For more information
-about the keyword arguments of the class, take a look at the :class:`CBD.converters.latexify.CBD2Latex`
+about the keyword arguments of the class, take a look at the :class:`pyCBD.converters.latexify.CBD2Latex`
 documentation.
 
 .. code-block:: python
@@ -33,10 +33,10 @@ documentation.
     cbd2latex = CBD2Latex(model, show_steps=True, render_latex=False)
 
 To simplify the system of equations, you can call the
-:func:`CBD.converters.latexify.CBD2Latex.CBD2Latex.simplify` method. When :code:`show_steps` was set to
+:func:`pyCBD.converters.latexify.CBD2Latex.CBD2Latex.simplify` method. When :code:`show_steps` was set to
 :code:`True`, all steps and additional information will be outputted to the console. If :code:`show_steps`
 was :code:`False`, you will see nothing in the console. After the simplification, you can obtain the
-string-representation of the equations using the :func:`CBD.converters.latexify.CBD2Latex.CBD2Latex.render`
+string-representation of the equations using the :func:`pyCBD.converters.latexify.CBD2Latex.CBD2Latex.render`
 method.
 
 .. code-block:: python
@@ -69,12 +69,10 @@ The output of this code is shown below:
 
 
 
-
-
 Submodules
 ----------
 
 .. toctree::
 
-   CBD.converters.latexify.CBD2Latex
-   CBD.converters.latexify.functions
+   pyCBD.converters.latexify.CBD2Latex
+   pyCBD.converters.latexify.functions

doc/pyCBD.converters.rst

@@ -0,0 +1,19 @@
+pyCBD.converters
+================
+
+.. automodule:: pyCBD.converters
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   pyCBD.converters.eq2CBD
+   pyCBD.converters.latexify
+   pyCBD.converters.CBD2C
+   pyCBD.converters.CBDDraw
+   pyCBD.converters.hybrid
+

doc/CBD.scheduling.rst

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

doc/pyCBD.lib.endpoints.rst

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

doc/CBD.lib.ev3.rst

@@ -14,9 +14,9 @@ This creates a (bootable) flashed microSD card that can run Python
 code. Simply write your CBD models and start your simulation!
 
 For convenience, some building blocks are prebuild in this
-:code:`CBD.lib.ev3` module.
+:code:`pyCBD.lib.ev3` module.
 
-.. automodule:: CBD.lib.ev3
+.. automodule:: pyCBD.lib.ev3
     :members:
     :undoc-members:
     :show-inheritance:

doc/pyCBD.lib.extra.rst

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

doc/CBD.simulator.rst

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

doc/CBD.lib.rst

@@ -1,7 +1,7 @@
 Standard CBD Library (BBL)
 ==========================
 
-.. automodule:: CBD.lib
+.. automodule:: pyCBD.lib
     :members:
     :undoc-members:
     :show-inheritance:
@@ -11,9 +11,9 @@ Submodules
 
 .. toctree::
 
-   CBD.lib.std
-   CBD.lib.io
-   CBD.lib.endpoints
-   CBD.lib.extra
-   CBD.lib.ev3
+   pyCBD.lib.std
+   pyCBD.lib.io
+   pyCBD.lib.endpoints
+   pyCBD.lib.extra
+   pyCBD.lib.ev3
 

doc/CBD.lib.extra.rst

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

doc/CBD.realtime.threadingGameLoop.rst

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

doc/pyCBD.loopsolvers.rst

@@ -0,0 +1,13 @@
+pyCBD.loopsolvers module
+========================
+
+.. automodule:: pyCBD.loopsolvers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. toctree::
+
+   pyCBD.loopsolvers.solver
+   pyCBD.loopsolvers.linearsolver
+   pyCBD.loopsolvers.sympysolver

doc/pyCBD.loopsolvers.solver.rst

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

doc/CBD.realtime.threadingBackend.rst

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

doc/pyCBD.naivelog.rst

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

doc/CBD.loopsolvers.sympysolver.rst

@@ -1,7 +1,7 @@
-CBD.loopsolvers.sympysolver module
+pyCBD.preprocessing.butcher module
 ==================================
 
-.. automodule:: CBD.loopsolvers.sympysolver
+.. automodule:: pyCBD.preprocessing.butcher
     :members:
     :undoc-members:
     :show-inheritance:

doc/pyCBD.preprocessing.rst

@@ -0,0 +1,16 @@
+pyCBD.preprocessing package
+===========================
+
+.. automodule:: pyCBD.preprocessing
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   pyCBD.preprocessing.butcher
+   pyCBD.preprocessing.rungekutta
+

doc/pyCBD.preprocessing.rungekutta.rst

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

doc/CBD.loopsolvers.linearsolver.rst

@@ -1,7 +1,7 @@
-CBD.loopsolvers.linearsolver module
+pyCBD.realtime.accurate_time module
 ===================================
 
-.. automodule:: CBD.loopsolvers.linearsolver
+.. automodule:: pyCBD.realtime.accurate_time
     :members:
     :undoc-members:
     :show-inheritance:

doc/pyCBD.realtime.plotting.rst

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

doc/pyCBD.realtime.rst

@@ -0,0 +1,21 @@
+pyCBD.realtime package
+======================
+
+.. automodule:: pyCBD.realtime
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   pyCBD.realtime.accurate_time
+   pyCBD.realtime.plotting
+   pyCBD.realtime.threadingBackend
+   pyCBD.realtime.threadingGameLoop
+   pyCBD.realtime.threadingGameLoopAlt
+   pyCBD.realtime.threadingPython
+   pyCBD.realtime.threadingTkInter
+

doc/pyCBD.realtime.threadingBackend.rst

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

doc/pyCBD.realtime.threadingGameLoop.rst

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

doc/pyCBD.realtime.threadingGameLoopAlt.rst

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

doc/pyCBD.realtime.threadingPython.rst

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

doc/pyCBD.realtime.threadingTkInter.rst

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

doc/pyCBD.rst

@@ -0,0 +1,33 @@
+pyCBD package
+=============
+
+.. automodule:: pyCBD
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    pyCBD.lib
+    pyCBD.realtime
+    pyCBD.tracers
+    pyCBD.converters
+    pyCBD.loopsolvers
+    pyCBD.state_events
+    pyCBD.preprocessing
+
+Submodules
+----------
+
+.. toctree::
+
+   pyCBD.Core
+   pyCBD.depGraph
+   pyCBD.naivelog
+   pyCBD.scheduling
+   pyCBD.simulator
+   pyCBD.util
+

doc/pyCBD.scheduling.rst

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

doc/pyCBD.simulator.rst

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

doc/pyCBD.state_events.locators.rst

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

doc/CBD.preprocessing.rst

@@ -1,7 +1,7 @@
-CBD.preprocessing package
+pyCBD.state_events module
 =========================
 
-.. automodule:: CBD.preprocessing
+.. automodule:: pyCBD.state_events
     :members:
     :undoc-members:
     :show-inheritance:
@@ -11,6 +11,5 @@ Submodules
 
 .. toctree::
 
-   CBD.preprocessing.butcher
-   CBD.preprocessing.rungekutta
+   pyCBD.state_events.locators
 

doc/pyCBD.tracers.baseTracer.rst

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

doc/pyCBD.tracers.color.rst

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

doc/pyCBD.tracers.rst

@@ -0,0 +1,17 @@
+pyCBD.tracers package
+=====================
+
+.. automodule:: pyCBD.tracers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   pyCBD.tracers.color
+   pyCBD.tracers.baseTracer
+   pyCBD.tracers.tracerVerbose
+

doc/pyCBD.tracers.tracerVerbose.rst

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

doc/pyCBD.util.rst

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

doc/running.rst

@@ -28,7 +28,7 @@ the simulator (before the :func:`run` method is called); for instance:
     # Show a progress indicator (requires `tqdm` to be installed)
     sim.setProgressBar()
 
-Take a look at the :class:`CBD.simulator.Simulator` class for more options
+Take a look at the :class:`pyCBD.simulator.Simulator` class for more options
 and information.
 
 Running the Tests

examples/scripts/BouncingBall/BouncingBall.py

@@ -1,6 +1,6 @@
-from CBD.Core import *
-from CBD.lib.std import *
-from CBD.lib.endpoints import SignalCollectorBlock
+from pyCBD.Core import *
+from pyCBD.lib.std import *
+from pyCBD.lib.endpoints import SignalCollectorBlock
 
 class BouncingBall(CBD):
 	def __init__(self, k=0.7):

examples/scripts/BouncingBall/BouncingBall_experiment.py

@@ -1,6 +1,6 @@
 from BouncingBall import *
-from CBD.realtime.plotting import PlotManager, LinePlot
-from CBD.simulator import Simulator
+from pyCBD.realtime.plotting import PlotManager, LinePlot
+from pyCBD.simulator import Simulator
 import matplotlib.pyplot as plt
 
 bb = BouncingBall()
@@ -27,8 +27,8 @@ manager = PlotManager()
 manager.register("height", bb.getBlockByName('plot1'), plot1, LinePlot(color='red'))
 # manager.register("velocity", bb.getBlockByName('plot2'), plot2, LinePlot(color='blue'))
 
-from CBD.state_events import StateEvent, Direction
-from CBD.state_events.locators import *
+from pyCBD.state_events import StateEvent, Direction
+from pyCBD.state_events.locators import *
 
 def bounce(e, t, model):
 	if e.output_name == "height":

examples/scripts/Dashboard/SinGen.py

@@ -1,11 +1,11 @@
-from CBD.Core import *
-from CBD.lib.std import *
+from pyCBD.Core import *
+from pyCBD.lib.std import *
 
 DELTA_T = 0.1
 
-from CBD.Core import CBD
-from CBD.lib.std import *
-from CBD.lib.endpoints import SignalCollectorBlock
+from pyCBD.Core import CBD
+from pyCBD.lib.std import *
+from pyCBD.lib.endpoints import SignalCollectorBlock
 
 class SinGen(CBD):
     def __init__(self, block_name):

examples/scripts/Dashboard/SinGen_experiment.py

@@ -1,5 +1,5 @@
 from SinGen import *
-from CBD.realtime.plotting import PlotManager, LinePlot, follow
+from pyCBD.realtime.plotting import PlotManager, LinePlot, follow
 import matplotlib.pyplot as plt
 import tkinter as tk
 from matplotlib.backends.backend_tkagg import FigureCanvasTkAgg
@@ -49,7 +49,7 @@ period = tk.Scale(root, label="Period", length=1200, orient=tk.HORIZONTAL, from_
 period.set(1.0)
 period.grid(column=1, row=4)
 
-from CBD.simulator import Simulator
+from pyCBD.simulator import Simulator
 
 sim = Simulator(cbd)
 sim.setRealTime()

examples/scripts/EvenNumberGen/EvenNumberGen.py

@@ -2,8 +2,8 @@
 # This file was automatically generated from drawio2cbd with the command:
 #   /home/red/git/DrawioConvert/__main__.py EvenNumberGen.xml -av -F CBD -e LCG -t 30 -f
 
-from CBD.Core import *
-from CBD.lib.std import *
+from pyCBD.Core import *
+from pyCBD.lib.std import *
 
 
 class Counter(CBD):

examples/scripts/EvenNumberGen/EvenNumberGen_experiment.py

@@ -2,9 +2,9 @@
 # This file was automatically generated from drawio2cbd with the command:
 #   /home/red/git/DrawioConvert/__main__.py EvenNumberGen.xml -av -F CBD -e LCG -t 30 -f
 
-from CBD.lib.endpoints import SignalCollectorBlock
+from pyCBD.lib.endpoints import SignalCollectorBlock
 from EvenNumberGen import *
-from CBD.simulator import Simulator
+from pyCBD.simulator import Simulator
 import matplotlib.pyplot as plt
 
 cbd = EvenNumberGen("gen")

examples/scripts/Fibonacci/Fibonacci.py

@@ -2,8 +2,8 @@
 # This file was automatically generated from drawio2cbd with the command:
 #   /home/red/git/DrawioConvert/__main__.py Fibonacci.xml -F CBD -e FibonacciGen -gvaf
 
-from CBD.Core import *
-from CBD.lib.std import *
+from pyCBD.Core import *
+from pyCBD.lib.std import *
 
 
 class FibonacciGen(CBD):

examples/scripts/Fibonacci/Fibonacci_experiment.py

@@ -3,7 +3,7 @@
 #   /home/red/git/DrawioConvert/__main__.py Fibonacci.xml -F CBD -e FibonacciGen -gvaf
 
 from Fibonacci import *
-from CBD.simulator import Simulator
+from pyCBD.simulator import Simulator
 import matplotlib.pyplot as plt
 
 

examples/scripts/LCG/LCG.py

@@ -2,8 +2,8 @@
 # This file was automatically generated from drawio2cbd with the command:
 #   /home/red/git/DrawioConvert/__main__.py LCG.xml -av -F CBD -e LCG -t 100
 
-from CBD.Core import *
-from CBD.lib.std import *
+from pyCBD.Core import *
+from pyCBD.lib.std import *
 
 
 class LCG(CBD):

examples/scripts/LCG/LCG_experiment.py

@@ -2,7 +2,7 @@
 # This file was automatically generated from drawio2cbd with the command:
 #   /home/red/git/DrawioConvert/__main__.py LCG.xml -av -F CBD -e LCG -t 30
 
-from CBD.simulator import Simulator
+from pyCBD.simulator import Simulator
 from LCG import *
 import matplotlib.pyplot as plt
 

examples/scripts/LCG2/LCG.py

@@ -2,9 +2,9 @@
 # This file was automatically generated from drawio2cbd with the command:
 #   /home/red/git/DrawioConvert/__main__.py LCG.xml -av -F CBD -e LCG -t 100
 
-from CBD.Core import *
-from CBD.lib.std import *
-from CBD.lib.endpoints import SignalCollectorBlock
+from pyCBD.Core import *
+from pyCBD.lib.std import *
+from pyCBD.lib.endpoints import SignalCollectorBlock
 
 
 class LCG(CBD):

examples/scripts/LCG2/LCG_experiment.py

@@ -3,10 +3,10 @@
 #   /home/red/git/DrawioConvert/__main__.py LCG.xml -av -F CBD -e LCG -t 30
 
 # from CBD.lib.plotting import SignalPlotBlock
-from CBD.simulator import Simulator
+from pyCBD.simulator import Simulator
 from LCG import *
 import matplotlib.pyplot as plt
-from CBD.realtime.plotting import PlotManager, ScatterPlot, follow
+from pyCBD.realtime.plotting import PlotManager, ScatterPlot, follow
 
 fig = plt.figure(figsize=(15, 5), dpi=100)
 ax = fig.add_subplot(1, 1, 1)

examples/scripts/LivePlot/SinGen.py

@@ -1,6 +1,6 @@
-from CBD.Core import *
-from CBD.lib.std import *
-from CBD.lib.endpoints import SignalCollectorBlock
+from pyCBD.Core import *
+from pyCBD.lib.std import *
+from pyCBD.lib.endpoints import SignalCollectorBlock
 
 DELTA_T = 0.1
 

examples/scripts/LivePlot/SinGen_bokeh_experiment.py

@@ -1,6 +1,6 @@
 from SinGen import *
-from CBD.realtime.plotting import PlotManager, Backend, StepPlot, follow
-from CBD.simulator import Simulator
+from pyCBD.realtime.plotting import PlotManager, Backend, StepPlot, follow
+from pyCBD.simulator import Simulator
 import sys, logging
 
 from bokeh.plotting import figure, curdoc

examples/scripts/LivePlot/SinGen_matplotlib_experiment.py

@@ -1,6 +1,6 @@
 from SinGen import *
-from CBD.realtime.plotting import PlotManager, LinePlot, follow
-from CBD.simulator import Simulator
+from pyCBD.realtime.plotting import PlotManager, LinePlot, follow
+from pyCBD.simulator import Simulator
 import matplotlib.pyplot as plt
 
 sinGen = SinGen("sin")
@@ -14,8 +14,8 @@ manager = PlotManager()
 manager.register("sin", sinGen.find('collector')[0], plot, LinePlot(color='red'))
 # manager.connect('sin', 'update', lambda d, axis=ax: axis.set_xlim(follow(d[0], 10.0, lower_bound=0.0)))
 manager.connect('sin', 'update', lambda d, p=plot: manager.set_xlim(p, follow(d[0], 10.0, lower_bound=0.0)))
-# NOTE: alternatively, the CBD.realtime.plotting.set_xlim method can be used:
-#   from CBD.realtime.plotting import set_xlim
+# NOTE: alternatively, the pyCBD.realtime.plotting.set_xlim method can be used:
+#   from pyCBD.realtime.plotting import set_xlim
 #   manager.connect('sin', 'update', lambda d, p=plot: manager.set_xlim(p, follow(d[0], 10.0, lower_bound=0.0)))
 
 sim = Simulator(sinGen)

examples/scripts/LivePlot/SinGen_seaborn_experiment.py

@@ -1,6 +1,6 @@
 from SinGen import *
-from CBD.realtime.plotting import PlotManager, LinePlot, follow, Backend
-from CBD.simulator import Simulator
+from pyCBD.realtime.plotting import PlotManager, LinePlot, follow, Backend
+from pyCBD.simulator import Simulator
 import matplotlib.pyplot as plt
 
 sinGen = SinGen("sin")

examples/scripts/LivePlot/SinGen_tkinter_experiment.py

@@ -1,6 +1,6 @@
 from SinGen import *
-from CBD.realtime.plotting import PlotManager, LinePlot, follow
-from CBD.simulator import Simulator
+from pyCBD.realtime.plotting import PlotManager, LinePlot, follow
+from pyCBD.simulator import Simulator
 
 import tkinter as tk
 import matplotlib.pyplot as plt

examples/scripts/SinGen/SinGen.py

@@ -2,8 +2,8 @@
 # This file was automatically generated from drawio2cbd with the command:
 #   /home/red/git/DrawioConvert/__main__.py SinGen.xml -fav -F CBD -e SinGen -E delta=0.1
 
-from CBD.Core import *
-from CBD.lib.std import *
+from pyCBD.Core import *
+from pyCBD.lib.std import *
 
 DELTA_T = 0.1
 

examples/scripts/SinGen/SinGen_experiment.py

@@ -3,7 +3,7 @@
 #   /home/red/git/DrawioConvert/__main__.py Fibonacci.xml -F CBD -e FibonacciGen -gvaf
 
 from SinGen import *
-from CBD.simulator import Simulator
+from pyCBD.simulator import Simulator
 import matplotlib.pyplot as plt
 
 

examples/scripts/SinGen/SinGen_gameloop_experiment.py

@@ -3,7 +3,7 @@
 #   /home/red/git/DrawioConvert/__main__.py Fibonacci.xml -F CBD -e FibonacciGen -gvaf
 
 from SinGen import *
-from CBD.simulator import Simulator
+from pyCBD.simulator import Simulator
 import matplotlib.pyplot as plt
 
 sinGen = SinGen("SinGen")

examples/scripts/SinGen/SinGen_latex_experiment.py

@@ -3,7 +3,7 @@
 #   /home/red/git/DrawioConvert/__main__.py Fibonacci.xml -F CBD -e FibonacciGen -gvaf
 
 from SinGen import *
-from CBD.converters.latexify import CBD2Latex
+from pyCBD.converters.latexify import CBD2Latex
 
 sinGen = SinGen("SinGen")
 cbd2latex = CBD2Latex(sinGen, show_steps=True, render_latex=False)

examples/scripts/SinGen/SinGen_threading_experiment.py

@@ -3,7 +3,7 @@
 #   /home/red/git/DrawioConvert/__main__.py Fibonacci.xml -F CBD -e FibonacciGen -gvaf
 
 from SinGen import *
-from CBD.simulator import Simulator
+from pyCBD.simulator import Simulator
 import matplotlib.pyplot as plt
 
 

examples/scripts/SinGen/SinGen_tkinter_experiment.py

@@ -3,7 +3,7 @@
 #   /home/red/git/DrawioConvert/__main__.py Fibonacci.xml -F CBD -e FibonacciGen -gvaf
 
 from SinGen import *
-from CBD.simulator import Simulator
+from pyCBD.simulator import Simulator
 import matplotlib.pyplot as plt
 import tkinter as tk
 

examples/scripts/algebraic-loop.py

@@ -1,5 +1,5 @@
-from CBD.Core import CBD
-from CBD.lib.std import *
+from pyCBD.Core import CBD
+from pyCBD.lib.std import *
 
 class Test(CBD):
 	def __init__(self, name):
@@ -26,8 +26,8 @@ class Test(CBD):
 if __name__ == '__main__':
 	test = Test("test")
 
-	from CBD.simulator import Simulator
-	from CBD.loopsolvers.sympysolver import SympySolver
+	from pyCBD.simulator import Simulator
+	from pyCBD.loopsolvers.sympysolver import SympySolver
 	import time
 
 	durations = []
@@ -65,6 +65,6 @@ if __name__ == '__main__':
 	print("Y", test.getSignalHistory("y"))
 
 	# C code gen testing:
-	# from CBD.converters.CBD2C import CBD2C
+	# from pyCBD.converters.CBD2C import CBD2C
 	# gen = CBD2C(test, 100)
 	# gen.generate("example.c")