Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -26,22 +26,52 @@
26	26	* **Libraries:**
27	27	** [[ipympl>>https://github.com/matplotlib/ipympl#installation]]
28	28	* (((
29		-**Extensions:***
	29	+**Extensions:**
30	30
31	31	(% class="box" %)
32	32	(((
33	33	jupyter labextension install @jupyter-widgets/jupyterlab-manager
34		-)))
35	35
36		-* (% class="box" %)
37		-(((
38	38	jupyter labextension install jupyter-matplotlib
39	39	)))
40	40	)))
41	41
42		-Then, to install the tvb-widgets library just type:
	39	+Then, to install the tvb-widgets library, just type:
43	43
44	44	(% class="box" %)
45	45	(((
46	46	pip install tvb-widgets
47	47	)))
	45	+
	46	+
	47	+== API usage ==
	48	+
	49	+First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command:
	50	+
	51	+(% class="box" %)
	52	+(((
	53	+%matplotlib widget
	54	+)))
	55	+
	56	+ Then, the TimeSeries widget (from the tvb-widgets API) and the display function should be imported:
	57	+
	58	+(% class="box" %)
	59	+(((
	60	+from tvbwidgets.api import TimeSeriesWidget
	61	+from IPython.core.display_functions import display
	62	+)))
	63	+
	64	+Assuming that the user has already created or imported a valid input, this is how the widget can be initialized and how an input can be assigned to it, using the //**add_datatype** //method (example below assumes that **//tsr//  **is a TVB TimeSeries datatype):
	65	+
	66	+(% class="box" %)
	67	+(((
	68	+tsw = TimeSeriesWidget()
	69	+tsw.add_datatype(tsr)
	70	+)))
	71	+
	72	+Finally, to display and interact with the TimeSeries widget, the **//get_widget//**// //method is used inside the //**display **//function:
	73	+
	74	+(% class="box" %)
	75	+(((
	76	+display(tsw.get_widget())
	77	+)))