Summary

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

Details

Page properties

Content

...	...	@@ -16,9 +16,8 @@
16	16	* for **3D**: (no_timepoints, state_variable/mode, no_channels)
17	17	* for **4D**: (no_timepoints, state_variable, no_channels, mode)
18	18
19		-~* Note that the TVB TimeSeries datatype is always is always 4D and already has the expected shape.
	19	+~* Note that the TVB TimeSeries datatype is always 4D and already has the expected shape.
20	20
21		-
22	22	== Requirements and installation ==
23	23
24	24	Before installing the tvb-widgets library containing the TimeSeries widget, the following python libraries and  Jupyter Notebook extensions should be installed:
...	...	@@ -42,3 +42,40 @@
42	42	(((
43	43	pip install tvb-widgets
44	44	)))
	44	+
	45	+
	46	+== API usage ==
	47	+
	48	+First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command:
	49	+
	50	+(% class="box" %)
	51	+(((
	52	+%matplotlib widget
	53	+)))
	54	+
	55	+ Then, the TimeSeries widget (from the tvb-widgets API) and the display function should be imported:
	56	+
	57	+(% class="box" %)
	58	+(((
	59	+from tvbwidgets.api import TimeSeriesWidget
	60	+from IPython.core.display_functions import display
	61	+)))
	62	+
	63	+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):
	64	+
	65	+(% class="box" %)
	66	+(((
	67	+tsw = TimeSeriesWidget()
	68	+tsw.add_datatype(tsr)
	69	+)))
	70	+
	71	+Finally, to display and interact with the TimeSeries widget, the **//get_widget//**// //method is used inside the //**display **//function:
	72	+
	73	+(% class="box" %)
	74	+(((
	75	+display(tsw.get_widget())
	76	+)))
	77	+
	78	+{{html}}
	79	+<iframe src="https://drive.google.com/file/d/1g4ryY1VIFMUD14Mb6Dq_KVb0b2_XU4VX/preview" width="840" height="480" allow="autoplay"></iframe>
	80	+{{/html}}