Newcomer guide

This page contains materials that can be useful for new engineers hired by Inria starting to work on OpenViBE and needing an introduction and pointers to the tools and systems, as well as to the people involved with OpenViBE.

Description of OpenViBE tools and systems

Working on OpenViBE involves various systems and tools, listed and explained here. Typically somebody else is responsible for the infrastructure behind the tool, but the OV engineers may be responsible for the openvibe specific configuration, content and sometimes also the related web software. If you need access to these tools, you can ask the people currently working with OpenViBE and/or Inria system administrators. N.b. When Jussi left, he gave Florian Nouviale, a SED engineer at Hybrid ( florian.nouviale@inria.fr ) admin access to the various systems.

Website: You are probably already on it. The OV engineers or SED Rennes have been taking care of updating the WordPress software, whereas the content is the responsiblity of the OV engineers & the researchers. The website is intended to host all the public documentation of the software (instead of being in the software distribution).

http://openvibe.inria.fr/

The website content and software (as well as the forum, the bug tracker and the openvibe dependency archives) are located on a web drive with the address https://webdav.irisa.fr/openvibe.inria.fr/htdocs. Additionally, the webpage contains an ‘OpenViBE Community Portal’ page but this has not been maintained or promoted since ca 2012.

Trello. Trello is a system that we have used to maintain task lists and todos over the years. It is a real treasure chest of past and intended tasks that can be searched if you want to know if somebody else has considered something issue/feature in the past, and other related information. The engineers have traditionally added and moved cards around according to their own tasks/interests. Trello does not cover Certivibe or Mensia’s developments. See below.

https://trello.com/b/6zaZOue7/openvibe

JIRA. Mensia Technologies uses JIRA to track their OpenViBE developments related to SDK and Designer and the associated tests. Their JIRA was used also for managing the Certivibe project, whose cards are not on Trello. If you need coordinates or access to the JIRA, please ask Mensia.

Mensia test suite. During Certivibe project, Mensia and Inria co-developed a lot of tests for OpenViBE using the robot  framework. As far as Jussi knows, these tests have not been exposed to the grand public. Before writing additional tests regarding SDK or Designer, its a good idea to coordinate with Mensia that duplicate tests are not written. Mensia is probably willing to let the Inria engineers access the tests privately, even if public distribution is not acceptable due to IP protection reasons (e.g. to assure that openvibe medical certification cannot be reached without Inria/Mensia getting compensated).

IRC Channel. The OpenViBE developers between Inria/Mensia have kept in touch on irc.freenode.net, channel #openvibe. The channel is not promoted or listed on public materials in order to keep the external support requests from newbies to the forum, where several users can benefit from the same answers.

Inria Gitlab. Inria Gitlab hosts the openvibe code repositories. Note that SDK,Designer repositories are mirrors of repositories hosted by Mensia (to guard the medical certification perimeter). The git conventions are described here.

https://gitlab.inria.fr/openvibe

Previous code repositories are on gforge, https://gforge.inria.fr/projects/openvibe/. The gforge is no longer used and the repositories should be considered locked.

Continuous Integration. OpenViBE nightly builds are done by Jenkins. The builds also run the currently public tests. The Jenkins configuration is stored in ov gitlab repository called ‘meta’. The jenkins configuration, slave maintenance, as well as making sure that the builds pass is the responsibility of the OV engineers. The Jenkins approach was made by Thierry Gaugry / Inria, if he’s still around he may be able to provide advice by e-mail.

https://ci.inria.fr/openvibe/

The virtual machine slaves are maintained by cloudstack, https://sesi-cloud-ctl1.inria.fr/client/

Bugtracker. External users can report bugs to Mantis. Reacting to the bug reports and updating the Mantis software is a responsibility of the OV engineers.

http://openvibe.inria.fr/tracker/

Community forum. OpenViBE users are encouraged to post their questions on the community forum. The forum needs to be moderated by the OpenViBE engineers who must also accept new accounts and the first post of each user (for spam control). The updating of the forum software is the responsibility of the OV engineers.

http://openvibe.inria.fr/forum/

SQL Backend. The bugtracker and forum depend on a MySQL backend hosted by IRISA. Sometimes this backend can go down and needs to be booted. There is a rare occasion you may need to manually login to the SQL server to issue some commands (e.g. if you wish to get some detailed statistics about users, posts etc). Since all openvibe engineers are very clever, and the forum software must somehow know how to access the database, the clever engineer that has filesystem level access to the forum materials can that way discover the address and the credentials that the forum is using.

Twitter. OpenViBE releases are advertised by tweeting with the account @openvibebci

Google Analytics. Statistics of openvibe downloads etc are kept by google analytics. The address is http://analytics.google.com. You will need an invite from engineer that currently has the access (in the past, Jozef and Jussi). Note that the analytics has lost information earlier to 2016 due to google policy change in May 2018.

Mailing lists. OpenViBE mailing lists have been hosted by Sympa (and before that, gforge). The policy has been to use the maililng lists for announcements and promote the forum instead. http://sympa.inria.fr/. Most of the mailing lists were moderated/maintained by the current OV lead engineer.

The lists are

openvibe-admin@inria.fr – Current administration of the OpenViBE web page and forum
openvibe-announce@inria.fr – Announcements to openvibe users
openvibe-consortium@inria.fr – List to reach the organizers of the OpenViBE Consortium
openvibe-consortium-announce@inria.fr – List to reach potential members of the OpenViBE consortium
openvibe-dev@inria.fr – List of the current developer team of OpenViBE @ Inria
openvibe-internal@inria.fr – List of the current Inria researchers/engineers involved with OpenViBE
openvibe-workshop@inria.fr – mailing list for the openvibe workshop

Document archive. Several old design documents and other non-published materials are stashed at

https://partage.inria.fr/alfresco/n/browse/workspace/SpacesStore/ec769a85-47b0-4948-bf6e-e3142972edbb

 

Release build machine.  A mythical beast located at team Hybrid @ Inria Rennes. The latest build machine – a laptop called ‘tichodrome‘ – contains such manufacturer libs and dlls that can be used to build the Windows installer but that we are not allowed to distribute to the public. This is the only piece of hardware which is on the responsibility of the OV engineers (albeit technically Inria IT support is responsible).

 

Release dependencies.  Dependencies for the release (proprietary driver files, confidential SDKs, etc) are also stored on a ‘inria-openvibe-backup’, an external 2TB Lacie harddrive at Hybrid/Inria Rennes. Look into the folder ‘openvibe-dependencies’. Be careful not to distribute proprietary files publicly which should be kept private.

Actors on the scene

In early 2019, the engineers with OpenViBE experience still working at Inria are Thibaut Monseigne (POTIOC), Thierry Gaugry (Hybrid) and Guillermo Andrade-Barroso (SED Rennes).

  • OpenViBE was initially developed by Yann Renard, and then subsequently led by Laurent Bonnet, Jozef Legeny, and Jussi T. Lindgren [ jtlindgr (at) gmail ],  working together with various other engineers (see contributors).
  • OpenViBE has been traditionally managed by the Hybrid team at Inria Rennes (Anatole Lecuyer), in collaboration with Inria teams POTIOC (Fabien Lotte), ATHENA (Maureen Clerc & Theodore Papadopoulo) and NeuroSys (Laurent Bougrain).
  • OpenViBE medical certification perimeter is maintained by Mensia Technologies (e.g. Benoit Perrin, Jozef Legeny). Mensia uses OpenViBE as a dual-licenced core for their products. Mensia’s staff includes experienced OpenViBE developers. We have some documentation about the processes.
  • OpenViBE Consortium is a set of parties interested in the future of the software in the sense that they may be ready to contribute funds in exchange for the wellbeing and future development of the software (contact: Anatole Lecuyer, David Margery). In 2018 such parties included the Inria BCI research groups, Mensia and several EEG device manufacturers. The consortium was nevertheless not yet launched at the time due to reorganizations related to InriaSoft / Fondation Inria.
  • Some EEG device manufacturers, notably gtec, Brain Products, and OpenBCI have been very supportive of OpenViBE in the past and been enthusiastic to have their drivers featured on the platform.
  • GIPSA LAB has a long history of maintaining a GIPSA OpenViBE extension (Marco Congedo, Anton Andreev).
  • OpenViBE userbase sometimes contributes code to be included in the software. For such contributions it has been important to consider the contribution rules before merging.
This entry was posted in Private documentation. Bookmark the permalink.