init

2021-10-14 13:47:35 +02:00
commit 6625a8dfaa
4026 changed files with 844291 additions and 0 deletions
@@ -0,0 +1,52 @@
+/**
+ * \page BoxAlgorithm_Python3Scripting Python 3 scripting
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_Python3Scripting_Description|
+ This box can process data from and to OpenViBE using Python script.
+ Available IO types are Streamed Matrix, Signal and Stimulations.
+ 
+ The user Python Script must define a new class that inherits from OVBox, 
+ and implements the initialize, process and uninitialize methods.
+ 
+ User script must end with : box = MyOVBox() where MyOVBox is the new class.
+ 
+ Please look at <a href="http://openvibe.inria.fr/tutorial-using-python-with-openvibe">the documentation page</a> for more details.
+
+ After version 2.2.0, Python 3 is used by default (Python 2 is no longer officially supported since January 1, 2020). To convert your previous scripts, python 3 has a script called <a href="https://docs.python.org/fr/3/library/2to3.html">2to3</a>.
+ 
+ * |OVP_DocEnd_BoxAlgorithm_Python3Scripting_Description|
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_Python3Scripting_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_Python3Scripting_Settings|
+
+ * |OVP_DocBegin_BoxAlgorithm_Python3Scripting_Setting1|
+ The box clock frequency. The Python process function is called at each tick.
+ * |OVP_DocEnd_BoxAlgorithm_Python3Scripting_Setting1|
+
+ * |OVP_DocBegin_BoxAlgorithm_Python3Scripting_Setting2|
+ The Python script file.
+ * |OVP_DocEnd_BoxAlgorithm_Python3Scripting_Setting2|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_Python3Scripting_Examples|
+ See <a href="http://openvibe.inria.fr/tutorial-using-python-with-openvibe">this page</a> for commented examples.
+ * |OVP_DocEnd_BoxAlgorithm_Python3Scripting_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_Python3Scripting_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_Python3Scripting_Miscellaneous|
+ */