Summary

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

Details

Page properties

Content

...	...	@@ -2,27 +2,27 @@
2	2
3	3	It is a Jupyter widget intended for the visualization of brain signals represented as time series.
4	4
5		-
6	6	== Inputs ==
7	7
8		-It supports time series inputs of two types:
	7	+Time series can be given as inputs in two forms:
9	9
10	10	* TVB TimeSeries datatype
11	11	* Numpy arrays
12	12
13		-The widget supports 2-, 3-, and 4-dimensional arrays. In all three cases, there is a fixed shape that the TimeSeries widget expects:
	12	+This widget supports 2D, 3D, and 4D arrays. In all three cases, there is a fixed shape that the TimeSeries widget expects:
14	14
15	15	* for **2D**: (no_timepoints, no_channels)
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 4D and already has the expected shape.
	18	+~* Note that the TVB TimeSeries datatype is always 4D and already has the expected shape.
20	20
21	21	== Requirements and installation ==
22	22
23		-Before installing the tvb-widgets library containing the TimeSeries widget, the following python libraries and  Jupyter Notebook extensions should be installed:
	22	+Before installing the tvb-widgets library containing the TimeSeries widget, the following python libraries and Jupyter extensions should be installed:
24	24
25	25	* **Libraries:**
	25	+** [[mne>>https://mne.tools/0.24/install/index.html]] version 0.24
26	26	** [[ipympl>>https://github.com/matplotlib/ipympl#installation]]
27	27	* (((
28	28	**Extensions:**
...	...	@@ -42,7 +42,6 @@
42	42	pip install tvb-widgets
43	43	)))
44	44
45		-
46	46	== API usage ==
47	47
48	48	First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command:
...	...	@@ -52,7 +52,7 @@
52	52	%matplotlib widget
53	53	)))
54	54
55		- Then, the TimeSeries widget (from the tvb-widgets API) and the display function should be imported:
	54	+ Then, the **TimeSeriesWidget** (from the tvb-widgets API) and the **//display//** function should be imported:
56	56
57	57	(% class="box" %)
58	58	(((
...	...	@@ -72,7 +72,7 @@
72	72
73	73	(% class="box" %)
74	74	(((
75		-display(tsw.get_widget())
	74	+display(tsw)
76	76	)))
77	77
78	78	{{html}}