Home Explore Help
Sign In
rparedis
/
pyCBD
Watch 1
Star 0
Fork 0
Files Issues 27 Pull Requests 0 Wiki
Branch: master
Branches Tags
pyCBD
/
doc
/
index.rst

index.rst 1.5 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 
  1. .. Copyright the Modelling, Simulation and Design Lab (MSDL)
    2. 

  2.       http://msdl.uantwerpen.be/
    3. 

  3. 

  4. .. drawio2cbd documentation master file, created by
    5. 

  5.    sphinx-quickstart on Mon Oct 19 12:31:01 2020.
    6. 

  6.    You can adapt this file completely to your liking, but it should at least
    7. 

  7.    contain the root `toctree` directive.
    8. 

  8. 

  9. Welcome to the pyCBD Simulator's Documentation!
    10. 

  10. ===============================================
    11. 

  11. 

  12. This package contains a CBD modelling and simulation framework, which can be used
    13. 

  13. to model complex systems of equations.
    14. 

  14. 

  15. :Authors:
    16. 

  16.   * Marc Provost
    17. 

  17.   * Hans Vangheluwe
    18. 

  18.   * Joachim Denil
    19. 

  19.   * Claudio Gomes
    20. 

  20.   * Randy Paredis
    21. 

  21. 

  22. :Python Version: :code:`>= 3.6`
    23. 

  23. 

  24. .. versionchanged:: 1.5
    25. 

  25.     Python 2 is no longer supported.
    26. 

  26. 

  27. .. note::
    28. 

  28.     This documentation is a mere description of the CBD modelling framework
    29. 

  29.     as it has been written in Python. When interested in creating visual
    30. 

  30.     models in this framework, take a look at
    31. 

  31.     `the DrawioConvert project <https://msdl.uantwerpen.be/git/rparedis/DrawioConvert>`_.
    32. 

  32. 

  33. .. toctree::
    34. 

  34.     :maxdepth: 2
    35. 

  35.     :caption: Setup
    36. 

  36. 

  37.     install
    38. 

  38.     running
    39. 

  39.     changelog
    40. 

  40.     issues
    41. 

  41. 

  42. .. toctree::
    43. 

  43.     :maxdepth: 2
    44. 

  44.     :caption: Simple Examples
    45. 

  45. 

  46.     examples/SinGen
    47. 

  47.     examples/EvenNumberGen
    48. 

  48.     examples/Fibonacci
    49. 

  49.     examples/LCG
    50. 

  50. 

  51. .. toctree::
    52. 

  52.     :maxdepth: 2
    53. 

  53.     :caption: Advanced Examples
    54. 

  54. 

  55.     examples/RealTime
    56. 

  56.     examples/LivePlot
    57. 

  57.     examples/Dashboard
    58. 

  58.     pyCBD.converters.latexify
    59. 

  59.     examples/ContinuousTime
    60. 

  60. 

  61. .. toctree::
    62. 

  62.     :maxdepth: 3
    63. 

  63.     :caption: Internal Documentation
    64. 

  64. 

  65.     pyCBD
    66. 

  66.