Installation

EyeSort is an EEGLAB plugin. Follow these steps to install it.

Prerequisites

Before installing EyeSort, ensure you have:

1. MATLAB installed (tested with MATLAB R2018b and later)
2. EEGLAB installed and working
   • Download from https://sccn.ucsd.edu/eeglab/
   • Tested with EEGLAB 2021.0 and later

Installation Steps

Step 1: Download EyeSort

Download the latest release from GitHub:

Download Latest Release

You can download either:

• The source code .zip or .tar.gz
• Or clone the repository: git clone https://github.com/emac-usf/EyeSort.git

Step 2: Copy to EEGLAB plugins directory

1. Locate your EEGLAB installation directory
2. Navigate to the plugins/ subdirectory
3. Copy the EyeSort folder into plugins/

Your directory structure should look like:

eeglab/
├── plugins/
│   ├── EyeSort/
│   │   ├── eegplugin_eyesort.m
│   │   ├── functions/
│   │   ├── pop_functions/
│   │   └── ...
│   └── (other plugins)

Step 3: Launch EEGLAB

1. Open MATLAB
2. Navigate to your EEGLAB directory
3. Run eeglab at the MATLAB command prompt

EyeSort will automatically add its subfolders to the MATLAB path when EEGLAB starts.

Step 4: Verify Installation

After EEGLAB opens, check that the EyeSort menu appears in the EEGLAB toolbar:

EEGLAB → EyeSort

You should see menu items like:

• 1. Load EEG Dataset(s)
• 2. Setup Interest Areas
• 3. Eye-Tracking Event Labeling
• Generate BINLISTER BDF File
• Save Labeled Dataset
• Help

If you see the EyeSort menu, installation was successful!

Troubleshooting

EyeSort menu doesn't appear

Possible causes:

1. EyeSort folder not in plugins directory

   • Ensure EyeSort/ is directly inside eeglab/plugins/
   • Don't nest it in additional subdirectories

2. Multiple copies of EyeSort

   • Check your MATLAB path for duplicate EyeSort installations
   • EyeSort will use the first copy found on the path
   • Remove duplicate installations

3. EEGLAB needs restart

   • Close EEGLAB and MATLAB completely
   • Reopen MATLAB and run eeglab again

Permission errors

If you get permission errors when copying files:

• On macOS/Linux: You may need to use sudo or change directory permissions
• On Windows: Run MATLAB as Administrator or adjust folder security settings

Next Steps

Once EyeSort is installed:

1. Read the First Run guide to understand the basic workflow
2. Download the sample dataset to test EyeSort
3. Follow a complete tutorial with your own data

Updating EyeSort

To update to a newer version:

1. Download the latest release
2. Delete or backup your old EyeSort/ folder in plugins/
3. Copy the new EyeSort/ folder into plugins/
4. Restart EEGLAB

Your saved configuration files (.mat files) will be preserved and should work with newer versions.