@@ -23,20 +23,37 @@ pip install lightning-python
2323``` python
2424from lightning import Lightning
2525
26- lightning = Lightning(host = " http://my-lightning-instance.herokuapp.com" )
27- lightning.create_session(" provide an optional session name" )
26+ lgn = Lightning(host = " http://my-lightning-instance.herokuapp.com" )
2827
29- lightning.line([1 ,2 ,3 ,4 ,5 ,6 ,7 ,8 ,0 ,- 2 ,2 ])
28+ lgn.create_session()
29+ lgn.create_session(" provide an optional session name" )
30+ ```
31+
32+ ### creating a visualization
33+ Methods are available for the default visualization types included with Lightning
34+ ``` python
35+ lgn.line([1 ,2 ,3 ,4 ,5 ,6 ,7 ,8 ,0 ,- 2 ,2 ])
36+ lgn.scatter([1 ,2 ,3 ],[2 ,9 ,4 ])
37+ ```
3038
39+ ### setting options
40+ Visualizations can be customized through optional parameters
41+ ``` python
42+ lgn.scatter([1 ,2 ,3 ],[2 ,9 ,4 ], label = [1 ,2 ,3 ], size = [5 ,10 ,20 ])
43+ ```
44+ ### using custom plots
45+ For custom plots not included with the default set, specify by name and provide data as a dictionary
46+ ``` python
47+ lgn.plot(data = {" series" : [1 ,2 ,3 ]}, type = ' line' )
3148```
3249
3350## examples
3451
35- http://nbviewer.ipython.org/github/lightning-viz/lightning-example-notebooks/tree/master/
52+ See a collection of [ IPython notebooks ] ( http://nbviewer.ipython.org/github/lightning-viz/lightning-example-notebooks/tree/master/ ) .
3653
3754## complete documentation
3855
39- http://lightning-viz.github.io/lightning-python/
56+ Available [ here ] ( http://lightning-viz.github.io/lightning-python/ ) .
4057
4158## running tests
4259
0 commit comments