Overview

Hybrid Harmony is a a Brain-Computer Interface (BCI) / multi-person neurofeedback application that supports the simultaneous recording of multiple (neurophysiological) datastreams and the real-time visualization and sonification of inter-brain synchrony. The program a backend that handles data and performs analyses, and a Graphical User Interface (GUI) made with PyQt5 for interactively control the analyses. Refer to the super-repository RhythmsofRelating for other sub-modules such as [LabVisuals] for visualization and LabRecorder for recording data.<br />

Please refer to

• Software Manual for instructions on how to interact with the software
• Software Modules for explanation of the backend
• This paper for an in-depth description of the project

When you use our software for your research or art project, please credit us :) you can add "Courtesy Harmonic Dissonance, 2010-present" and/or cite the paper linked above.

If you are interested in our project for specific applications, please contact Suzanne at sdikker at gmail dot com

Requirements

• Python >= 3.6

Installation

• This project uses pipenv to manage Python dependencies.

• For Windows users, download the latest release and run the executable file titled HybridHarmony vx.x.exe. Here is v1.0.

• For developers and Mac users, refer to the following steps:

1. When using git: Clone the repository's "devel-PC" branch

$ git clone -b devel-PC https://github.com/RhythmsOfRelating/HybridHarmony.git

2. (Old)After downloading Python3.x, open Terminal (MacOS) or Command Prompt (Windows) and direct to HybridHarmony directory, and install pipenv:

$ pip install pipenv

2.1 (New) If you have multiple versions of Python installed, the version needs to be specified so the OS knows the right version of pip to use. For example, if you want to use Python3.7 run:

$ python37 -m pip install %package_name%

This command works also if you have only one version of Python, in that case there is no need to specify the version:

$ python -m pip install %package_name%

In addition, it is recommended to use pipx to install Python libraries in a clean and isolated environment:

$ python -m pip install --user pipx

Using pipx you can install pipenv with the command:

$ python -m pipx install pipenv

(Optional) If your shell is not able to find pipenv it means that the executable has not been added to your PATH variable. To add it you can do it manually using the standard procedure recommended for your OS (Windows, MacOS or Linux), otherwise you can run the following command to let pipx handle it for you. NOTE: this will add all the executables contained in the storage of the called version of pipx to the PATH variable, if you want to remove them you will need to do so manually:

$ python -m pipx ensurepath

3. Inside the LSLanalysis directory, install the dependencies:

$ pipenv install -r requirements.txt

4. Activate the virual environment:

$ pipenv shell

Note that after the initial setup, steps 1-3 can be omitted and users should start from step 4.

5. Run the python script:

$ python main_GUI.py

6. The following window should pop up:

   <img src="https://github.com/RhythmsOfRelating/HybridHarmony/blob/master/tutorial/default.png" width="400">

7. Follow the manual to interact with the software.