Skip to content

Commit f1d8567

Browse files
committed
Added plotting section to the user guide
1 parent 5f48d40 commit f1d8567

2 files changed

Lines changed: 38 additions & 0 deletions

File tree

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,4 @@ data streaming systems like `Apache Flink <https://flink.apache.org/>`_,
116116
api.rst
117117
collections-api.rst
118118
async.rst
119+
plotting.rst

docs/source/plotting.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Visualizing streamz
2+
===================
3+
4+
A variety of tools are available to help you understand, debug, visualize your streaming objects:
5+
6+
- Most Streamz objects automatically display themselves in Jupyter notebooks, periodically updating their visual representation as text or tables by registering events with the Tornado IOLoop used by Jupyter
7+
- The network graph underlying a stream can be visualized using `dot` to render a PNG using `Stream.visualize(filename)`
8+
- Streaming data can be visualized using the optional separate packages hvPlot, HoloViews, and Panel (see below)
9+
10+
11+
hvplot.streamz
12+
--------------
13+
14+
hvPlot is a separate plotting library providing Bokeh-based plots for Pandas dataframes and a variety of other object types, including streamz DataFrame and Series objects.
15+
16+
See `hvplot.holoviz.org <https://hvplot.holoviz.org>`_ for instructions on how to install hvplot. Once it is installed, you can use the Pandas .plot() API to get a dynamically updating plot in Jupyter or in Bokeh/Panel Server:
17+
18+
.. code-block:: python
19+
20+
import hvplot.streamz
21+
from streamz.dataframe import Random
22+
23+
df = Random()
24+
df.hvplot(backlog=100)
25+
26+
See the `streaming section <https://hvplot.holoviz.org/user_guide/Streaming.html>`_ of the hvPlot user guide for more details, and the
27+
`dataframes.ipynb` example that comes with streamz for a simple runnable example.
28+
29+
30+
HoloViews
31+
---------
32+
hvPlot is built on HoloViews, and you can also use HoloViews directly if you want more control over events and how they are processed. See the `HoloViews user guide <http://holoviews.org/user_guide/Streaming_Data.html>`_ for more details.
33+
34+
35+
Panel
36+
-----
37+
Panel is a general purpose dashboard and app framework, supporting a wide variety of displayable objects as "Panes". Panel provides a `streamz Pane <https://panel.holoviz.org/reference/panes/Streamz.html>`_ for rendering arbitrary streamz objects, and streamz DataFrames are handled by the Panel `DataFrame Pane <https://panel.holoviz.org/reference/panes/DataFrame.html>`_.

0 commit comments

Comments
 (0)