index.rst 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .. ThingFlow-Python documentation master file, created by
  2. sphinx-quickstart on Mon Mar 27 14:14:59 2017.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. ThingFlow-Python
  6. ================
  7. ThingFlow is a (Python3) framework for building IoT event
  8. processing dataflows. [#]_ The goal of this framework is to support the
  9. creation of robust IoT systems from reusable components. These systems must
  10. account for noisy/missing sensor data, distributed computation, and the need for
  11. local (near the data source) processing.
  12. The source repository for ThingFlow-python is at https://github.com/mpi-sws-rse/thingflow-python.
  13. Sections 1 and 2 of this documentation cover how to get started. Sections 3
  14. through 5 cover more advanced topics. Section 6 provides some more code examples.
  15. Section 7 covers our port of ThingFlow to
  16. MicroPython on the ESP8266. Section 8 documents some design decisions made during
  17. the evolution of ThingFlow. Finally, Section 9 contains reference
  18. documentation for the full ThingFlow-python API (extracted from the docstrings).
  19. .. [#] *ThingFlow* was originally known as *AntEvents*.
  20. Contents:
  21. .. toctree::
  22. :maxdepth: 2
  23. intro
  24. tutorial
  25. output_things
  26. ports
  27. functional-api
  28. more-examples
  29. micropython
  30. design-notes
  31. reference
  32. Indices and tables
  33. ==================
  34. * :ref:`genindex`
  35. * :ref:`modindex`
  36. * :ref:`search`