Summary

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

Details

Page properties

Content

...	...	@@ -44,10 +44,8 @@
44	44
45	45	Before installing the tvb-widgets library containing the PhasePlane widget, the following python libraries and Jupyter extensions should be installed:
46	46
47		-* **Libraries:**
48		-
49		- ​​​​​​[[ipympl>>https://github.com/matplotlib/ipympl#installation]]
50		-
	47	+* **Libraries:​​​​​**
	48	+** ​​​​​​[[ipympl>>https://github.com/matplotlib/ipympl#installation]]
51	51	* **Extensions:**
52	52
53	53	(% class="box" %)
...	...	@@ -63,3 +63,38 @@
63	63	(((
64	64	pip install tvb-widgets
65	65	)))
	64	+
	65	+== API usage ==
	66	+
	67	+First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command:
	68	+
	69	+(% class="box" %)
	70	+(((
	71	+%matplotlib widget
	72	+)))
	73	+
	74	+Then, the PhasePlaneWidget (from the tvb-widgets API), the package lab (from tvb simulator) and the display function should be imported:
	75	+
	76	+(% class="box" %)
	77	+(((
	78	+{{{from tvbwidgets.api import PhasePlaneWidget
	79	+from tvb.simulator.lab import *
	80	+}}}
	81	+
	82	+{{{from IPython.core.display_functions import display}}}
	83	+)))
	84	+
	85	+The widget can be initialized with the required parameters (Model and Integrator) as it shows below:
	86	+
	87	+(% class="box" %)
	88	+(((
	89	+{{{w = PhasePlaneWidget(model=models.Generic2dOscillator(),
	90	+ integrator=integrators.HeunDeterministic())}}}
	91	+)))
	92	+
	93	+Finally, to display and interact with the PhasePlane widget, the **//get_widget//**// //method is used inside the //**display **//function:
	94	+
	95	+(% class="box" %)
	96	+(((
	97	+{{{display(w.get_widget(plot_size=(6,7)))}}}
	98	+)))