Getting started

Once the environment is installed, make sure that you have the following:

1. Stimulus files
   Place all speech or audio stimuli used in your EEG listening experiment in a single folder. Each stimulus should be saved as an individual .wav file.

2. Preprocessed EEG files
   This toolbox assumes that EEG preprocessing has already been completed, including steps such as filtering, ICA, resampling, and epoching. The preprocessed data should be saved as mne.Epochs in .fif files in the same folder. Each epoch should correspond to one stimulus audio track.

3. Metadata file
   Prepare a .csv spreadsheet that lists each EEG data file and its associated metadata. This spreadsheet will be used to link EEG data to the corresponding stimulus files. At minimum, the metadata file should include:

   • A column containing the EEG data filenames.
   • A column containing the stimulus filenames, including file extensions, for all epochs in the corresponding EEG file. Multiple stimulus filenames should be separated by semicolons (;).

   For example, a minimal metadata file may look like this:

   filename	stim
   sub-01_task-alice.fif	track1.wav;track2.wav;track3.wav;track4.wav;track5.wav

   In this example, sub-01_task-alice.fif contains five epochs, and the stim column lists the corresponding stimulus files in epoch order, separated by semicolons.

   You are encouraged to add any additional metadata columns that may be useful for your analysis, such as participant ID, session, listening condition, etc. See misc/example_metadata.csv for an example.