• Stars
    star
    149
  • Rank 248,619 (Top 5 %)
  • Language
    Jupyter Notebook
  • Created over 10 years ago
  • Updated about 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Demos of Plotly's Real-time Streaming API

Plotly's Real-Time Streaming API

This is an example of a real-time plotly graph: http://plot.ly/~streaming-demos/6/

  • You and I see the same data, updating at the same time. Try this: open up a streaming plot in two different browser windows.

  • Plotly streaming graphs are immediately shareable -- by shortlink or as embedded in website or an IPython notebook

  • Owners of plotly graphs can edit their with the plotly web-app. All of the viewers of the graph will see the changes update live

  • It's fast: graphs update up to 20 times / second.

This repo contains several examples for working with the Plotly streaming API. All of the examples are running in real-time on a remote server. View the IPython notebooks in nbviewer here: nbviewer.ipython.org/github/plotly/Streaming-Demos

Questions? Suggestions? Made a sweet real-time graph? Get in touch at [email protected] or @plotlygraphs!

See the individual folders for detailed documentation.

Examples

Plotly's Python API

Examples of Plotly's Streaming API together with Plotly's Python API in the User Guide.

The example IPython notebooks in the User Guide are up-to-date with the latest version of Plotly's Python API (version 1.0.*), unlike the examples in the IPython examples folder of this repository.


Graphing Real-time Sensor Data

Mock Signal Data

The live graph, running from a Node server: https://plot.ly/~streaming-demos/6/. View the code in the Node folder in this repo.

The live graph, running from an IPython server: https://plot.ly/~streaming-demos/12/. View the code in the IPython folder in this repo.

Embedded systems

Our real-time heart rate monitor (click to view the video):

The Arduino Yún library is here: https://github.com/plotly/arduino-api/tree/master/plotly_yun

Raspbery Pi

Example code with the Plotly-Python library: https://github.com/plotly/raspberrypi

Graphing the Real-time Twitter Stream

Graphing the Twitter Stream in Plotly

Implemented in Node, example code is in this repo.

Plotting Simulations

Double Pendulum Simluation in Plotly

View the live, never-ending double pendulum simulation graph in our IPython notebook here: http://nbviewer.ipython.org/github/plotly/Streaming-Demos/blob/master/IPython%20examples/Simulation%20-%20Double%20Pendulum.ipynb

Animations

Hans Rosling Bubble Chart in Plotly

View the live, forever-repeating Hans Rosling bubble chart graph in an IPython notebook here: http://nbviewer.ipython.org/github/plotly/Streaming-Demos/blob/master/IPython%20examples/Animation%20-%20Gapminder%20Bubble%20Charts.ipynb

Basic streaming concepts

Streaming has been added as an additional API layer on top of our static graph API. Therefore you follow the steps for making an API call to our plotting server and once confirmation is given proceed to stream data to the given address. Here is a little node.js demo:

Plotly = require("plotly")
data = {
    'x':[]
  , 'y':[]
  , 'type':'scatter'
  , 'mode':'lines'
  , stream: {
    "token": token
  }
}
plotly.plot(data, un, key, layout)
})

That should give you a response which will look something like

stream-host: 'http://stream.plot.ly',
stream-status: 'All Streams Go!',
url: 'https://plot.ly/~BenPostlethwaite/0',
filename: 'streamsAGoGO',
message: 'High five! You successfuly sent some data to your account on plotly.
View your plot in your browser at https://plot.ly/~BenPostlethwaite/0
or inside your plot.ly account where it is named "streamsAGoGo"'

All Streams Go! So now the streaming cluster has been initialized with your information and the streaming token has been configured to a particular data object. The return message shows us the sharable plot URL where we can view our streaming data as well as the address to stream to. So let's start our stream!

var hyperquest = require("hyperquest")
var signalStream = require("random-signal")()
var options =  {
    method: 'POST'
  , uri: "http://stream.plot.ly/"
  , headers: {
  , "plotly-streamtoken": token
  }
}
var plotlyStream = hyperquest(options)
signalStream.pipe(req)

And that's it!

Intermediate streaming concepts

  • Data MUST be sent as newline separated stringified JSON. The stream server parses incoming data streams on newlines, so without newlines it will assume a very long single JSON object and eventually just destroy the stream.
'{ "x": 3, "y": 1 }\n'
  • Incoming data should not be written faster than 50ms. We throttle incoming JSON objects at 50ms. While there is a buffer continuing to send data faster than 50ms will result in data loss.
  • You can send multiple streams to the same plot by nesting stream tokens within the corrisponding data trace object. Similarly you can use the same token for multiple traces in a plot (they will show the same stream, so this is useful only in when using subplots).

Advanced streaming concepts

  • You must send data every minute otherwise we will consider the stream stale and destroy it. If your data comes in a slower rate send a heartbeat to let the server know it is still active. A heartbeat is simply a newline "\n" written within the minute window.

HTTP Details

Plotly's streaming-API accepts chunked-encoded HTTP posts and allows these connections to be held open indefinitely. Here is an example of a raw HTTP post:

POST / HTTP/1.1\r\n
Host: stream.plot.ly\r\n
User-Agent: Python\r\n
Transfer-Encoding: chunked\r\n
Connection: close\r\n
plotly-streamtoken: ab3dk4FBDd\r\n
\r\n
11\r\n
{"y": 1, "x": 1}\n\r\n
11\r\n
{"y": 2, "x": 2}\n\r\n
11\r\n
{"y": 3, "x": 3}\n\r\n
0\r\n
\r\n

A few key points:

  • An additional header is embedded in the POST: plotly-streamtoken
  • In HTTP every "chunk" of data (e.g. {"y": 3, "x": 3}\n) must be preceded with the length of the chunk in hex. Also, every line is separated by a \r\n
  • Plotly plots every chunk of data in your browser as soon as it recieves it
  • Data can be sent to plotly indefinitely, but we'll close connections if we don't hear anything for 1 minute. You can keep the connection open by sending a heartbeat every minute with a new line: \n. Connections are closed with 0\r\n\r\n

A low-level HTTP example with Python's socket and httlib libraries are in this repo, view it in nbviewer here: http://nbviewer.ipython.org/github/plotly/Streaming-Demos/tree/master/IPython%20examples/http%20details/

Contact Us

Lead Streaming Engineer - [email protected]

Lead API Engineer - [email protected]

twitter @plotlygraphs

More Repositories

1

dash

Data Apps & Dashboards for Python. No JavaScript Required.
Python
19,422
star
2

plotly.js

Open-source JavaScript charting library behind Plotly and Dash
JavaScript
16,743
star
3

plotly.py

The interactive graphing library for Python ✨ This project now includes Plotly Express!
Python
15,980
star
4

falcon

Free, open-source SQL client for Windows and Mac 🦅
JavaScript
5,130
star
5

dash-sample-apps

Open-source demos hosted on Dash Gallery
Jupyter Notebook
3,133
star
6

plotly.R

An interactive graphing library for R
R
2,549
star
7

plotly.rs

Plotly for Rust
Rust
1,093
star
8

dash-recipes

A collection of scripts and examples created while answering questions from the greater Dash community
Python
989
star
9

react-plotly.js

A plotly.js React component from Plotly 📈
JavaScript
922
star
10

react-pivottable

React-based drag'n'drop pivot table with Plotly.js charts
JavaScript
907
star
11

jupyter-dash

Develop Dash apps in the Jupyter Notebook and JupyterLab
Python
906
star
12

plotly_express

Plotly Express - Simple syntax for complex charts. Now integrated into plotly.py!
Python
685
star
13

Plotly.NET

interactive graphing library for .NET programming languages 📈
F#
654
star
14

datasets

Datasets used in Plotly examples and documentation
HTML
637
star
15

dash-cytoscape

Interactive network visualization in Python and Dash, powered by Cytoscape.js
Python
592
star
16

dash-bio

Open-source bioinformatics components for Dash
Python
528
star
17

Dash.jl

Dash for Julia - A Julia interface to the Dash ecosystem for creating analytic web applications in Julia. No JavaScript required.
Julia
486
star
18

react-cytoscapejs

React component for Cytoscape.js network visualisations
JavaScript
472
star
19

react-chart-editor

Customizable React-based editor panel for Plotly charts
JavaScript
460
star
20

spectacle-editor

Drag and drop Spectacle editor.
JavaScript
442
star
21

dash-table

OBSOLETE: now part of https://github.com/plotly/dash
Python
421
star
22

documentation

Issue tracker for Plotly's open-source documentation.
419
star
23

dashR

Create data science and AI web apps in R
JavaScript
382
star
24

plotly_matlab

Plotly Graphing Library for MATLAB®
MATLAB
375
star
25

dash-docs

📖 ISSUE TRACKER ONLY for The Official Dash Userguide & Documentation https://dash.plotly.com/
Python
371
star
26

Kaleido

Fast static image export for web-based visualization libraries with zero dependencies
PostScript
362
star
27

jupyterlab-dash

An Extension for the Interactive development of Dash apps in JupyterLab
Python
360
star
28

orca

Command line application for generating static images of interactive plotly charts
JavaScript
294
star
29

dash-core-components

OBSOLETE: now part of https://github.com/plotly/dash
Python
270
star
30

dash-component-boilerplate

Get started creating your own Dash components here.
Python
269
star
31

IPython-plotly

A collection of data science IPython notebooks with Plotly graphs
HTML
266
star
32

angular-plotly.js

TypeScript
229
star
33

jupyterlab-chart-editor

JupyterLab extension for Plotly's react-chart-editor
TypeScript
213
star
34

arduino-api

Arduino library for real-time logging and streaming data to online plotly graphs
Python
209
star
35

dash-pivottable

react-pivottable in Dash
Python
192
star
36

dash-oil-and-gas-demo

Dash Demo App - New York Oil and Gas
Python
182
star
37

plotlyjs-flask-example

A simple plotly.js example served with flask
Python
179
star
38

dashboards

Superseded by Dash!
179
star
39

dash-detr

A User Interface for DETR built with Dash. 100% Python.
Python
178
star
40

dash-table-experiments

NO LONGER SUPPORTED - use https://github.com/plotly/dash-table instead
JavaScript
175
star
41

dash-ag-grid

Dash AG Grid is a high-performance and highly customizable component that wraps AG Grid, designed for creating rich datagrids.
Python
170
star
42

plotly-nodejs

node.js wrapper for Plotly's Chart Studio Streaming and REST APIs
JavaScript
166
star
43

colorlover

Color scales in Python for humans
Python
158
star
44

dash-html-components

OBSOLETE - now part of https://github.com/plotly/dash
Python
154
star
45

dash-svm

Interactive SVM Explorer, using Dash and scikit-learn
Python
153
star
46

dash-labs

Work-in-progress technical previews of potential future Dash features.
Python
139
star
47

dash-daq

Control components for Dash
JavaScript
137
star
48

dash-technical-charting

Powerful technical charting app/interface in pure Python
Python
133
star
49

dash-stock-tickers-demo-app

Dash Demo App - Stock Tickers
CSS
131
star
50

dash-vtk

Bringing vtk.js into Dash and Python
Python
120
star
51

dash-salesforce-crm

118
star
52

python-user-guide

MOVED!
115
star
53

dashboards.ly

Superseded by Dash!
HTML
107
star
54

dash-renderer

OBSOLETE has been merged into dash
JavaScript
97
star
55

Plotly.jl

A Julia interface to the plot.ly plotting library and cloud services
Julia
93
star
56

raspberrypi

Realtime Streaming with the Raspberry Pi and Plot.ly Python Library
Python
91
star
57

dash-deck

Bringing deck.gl and pydeck into Dash
JavaScript
90
star
58

dash-canvas

An interactive image editing component for Dash
Python
84
star
59

dash-image-processing

Dash Demo App - Image Processing App
Python
82
star
60

dash-volatility-surface

Volatility surface explorer in pure Python
Python
79
star
61

dash-player

Dash Component wrapping React-Player
Python
77
star
62

dash-world-cell-towers

A Dash app for exploring the world cell tower dataset provided by OpenCellid
Python
72
star
63

dash-auth

Basic Auth and Plotly Authentication for Dash Apps
Python
72
star
64

Dash.NET

F# interface to Dash- the most downloaded framework for building ML & data science web apps
F#
68
star
65

dash-alternative-viz

Dash components & demos to create Altair, Matplotlib, Highcharts , and Bokeh graphs within Dash apps.
JavaScript
67
star
66

dash-heroku-template

Fool-proof template for deploying Dash apps on Heroku
Python
64
star
67

simple-example-chart-apps

Some very simple apps to demonstrate the chart types on the Plotly website.
CSS
54
star
68

postMessage-API

Bind custom interactivity to embedded Plotly graphs
HTML
52
star
69

graphing-library-docs

Plotly's graphing libraries documentation.
Jupyter Notebook
52
star
70

rasterly

Rapidly generate raster images from large datasets in R with Plotly.js
R
48
star
71

dash-opioid-epidemic-demo

US county data for poision-induced deaths, years 1999-2015
HTML
48
star
72

dash-redis-celery-periodic-updates

Demo apps now maintained in https://github.com/plotly/dash-enterprise-docs
Python
48
star
73

dash-dangerously-set-inner-html

Dash component to dangerously set inner raw HTML
Python
45
star
74

dash-px

Simple Dash app using Plotly Express
Python
43
star
75

dash-sunburst

Dash / React + D3 tutorial: Sunburst diagrams
Python
43
star
76

dash-network

A tutorial & demo on how to port the D3 force-layout network diagram to Dash
JavaScript
43
star
77

academy

CSS
42
star
78

public-health

⚕ Tutorials for public health crossfilter dashboards
42
star
79

ruby-api

A Ruby wrapper to the plot.ly REST API.
Ruby
41
star
80

react-colorscales

A React UI component for picking and modifying colorscales
JavaScript
37
star
81

dash-yield-curve

Remake of the NYTimes yield curve demo
CSS
37
star
82

dash-app-stylesheets

Hosting Dash app stylesheets
CSS
36
star
83

plotly.github.io

Help pages for Chart Studio
CSS
35
star
84

dash-dbx-sql

Simple Dash app demonstrating connection to Databricks via the Python SQL connector
Python
35
star
85

plotly-notebook-js

A package for using plotly in Tonicdev and Jupyter notebooks.
JavaScript
34
star
86

canvas-portal

Gallery of examples for dash-canvas
CSS
34
star
87

dash-brain-surface-viewer

Dash app for viewing brain surfaces saved as MNI files. Data from https://github.com/aces/brainbrowser
Python
33
star
88

dash-components-archetype

Deprecated. A Builder archetype for Dash component suites. See the new version here: https://github.com/plotly/dash-component-boilerplate
JavaScript
32
star
89

R-User-Guide

The Official User-Guide to Plotly's R API and ggplotly
31
star
90

plotly.js-crossfilter.js

A simple example showing Plotly.js and Crossfilter.js working together.
JavaScript
31
star
91

all-in-ai-demo-app

Dash application presented by Nathan Drezner at the All in AI (https://allinevent.ai/) conference in Montreal on September 27, 2023
Python
31
star
92

plotly-webpack

Example repo for bundling plotly.js with webpack and browserify
JavaScript
30
star
93

spotfire

Create D3.js visualizations in spotfire with Plotly
29
star
94

dash-alternative-viz-demo

Components for using Dash with Matplotlib, Seaborn, Bokeh, Holoviews, and Altair.
Python
28
star
95

dashdub

Convert speech to text with Dash & Python
Jupyter Notebook
28
star
96

plotcon-2017-plotlyjs-workshop

Syllabus and materials for plotly.js workshop at PLOTCON 2017
28
star
97

workshop

Plotly API Hardware Use Cases
Arduino
27
star
98

react-ipython-notebook

React component for nbconvert.js
JavaScript
27
star
99

excel-plugin

Plotly Excel Plugin
C#
26
star
100

dash-datashader

A demo app for visualizing hundreds of millions of data points interactively with Dash and Datashader.
Python
25
star