a b/README.md 

  1
  
[![GitHub issues](https://img.shields.io/github/issues/sccn/eeglab?color=%23fa251e&logo=GitHub)](https://github.com/sccn/eeglab/issues)





  
  

  2
  
![Twitter Follow](https://img.shields.io/twitter/follow/eeglab2?style=social)





  
  

  3
  





  
  

  4
  
# What is EEGLAB?





  
  

  5
  
EEGLAB is an open source signal processing environment for electrophysiological signals running on Matlab and Octave (command line only for Octave). This folder contains original Matlab functions from the EEGLAB (formerly ICA/EEG) Matlab toolbox, all released under the Gnu public license (see eeglablicence.txt). See the EEGLAB tutorial and reference paper (URLs given below) for more information.





  
  

  6
  





  
  

  7
  
# Installing/cloning





  
  

  8
  
**Recommended:** Download the official EEGLAB release from https://sccn.ucsd.edu/eeglab/download.php





  
  

  9
  





  
  

  10
  
**Do not download a ZIP file directly from GIT as it will not contain EEGLAB submodules**. Instead clone the reposity while pulling EEGLAB sub-modules.





  
  

  11
  





  
  

  12
  
```





  
  

  13
  
git clone --recurse-submodules https://github.com/sccn/eeglab.git





  
  

  14
  
```





  
  

  15
  





  
  

  16
  
If you forgot to clone the submodule, go to the eeglab folder and type





  
  

  17
  





  
  

  18
  
```





  
  

  19
  
git submodule update --init --recursive --remote





  
  

  20
  
git pull --recurse-submodules





  
  

  21
  
```





  
  

  22
  





  
  

  23
  
# Sub-directories:





  
  

  24
  





  
  

  25
  
 - /functions - All distributed EEGLAB functions (admin, sigproc, pop, misc)





  
  

  26
  
 - /plugins   - Directory to place all downloaded EEGLAB plug-ins. dipfit (1.0) is present by default





  
  

  27
  
 - /sample_data -  Miscellaneous EEGLAB data using in tutorials and references





  
  

  28
  
 - /sample_locs -  Miscellaneous standard channel location files (10-10, 10-20). See the EEGLAB web site http://sccn.ucsd.edu/eeglab/ for more.





  
  

  29
  





  
  

  30
  
# To use EEGLAB: 





  
  

  31
  





  
  

  32
  
1. Start Matlab





  
  

  33
  





  
  

  34
  
2. Use Matlab to navigate to the folder containing EEGLAB





  
  

  35
  





  
  

  36
  
3. Type "eeglab" at the Matlab command prompt ">>" and press enter





  
  

  37
  





  
  

  38
  
3. Open the main EEGLAB tutorial page (http://sccn.ucsd.edu/wiki/EEGLAB_Wiki)





  
  

  39
  





  
  

  40
  
4. Please send feedback and suggestions to: eeglab@sccn.ucsd.edu





  
  

  41
  





  
  

  42
  
# In publications, please reference:





  
  

  43
  





  
  

  44
  
Delorme, A., & Makeig, S. (2004). EEGLAB: an open source toolbox for analysis of single-trial EEG dynamics including independent component analysis. Journal of neuroscience methods, 134(1), 9-21. (See article [here](http://sccn.ucsd.edu/eeglab/download/eeglab_jnm03.pdf))





  
  

  45
  
 





  
  

  46
  
# Compiled version of EEGLAB





  
  

  47
  





  
  

  48
  
If you experience problems, try running EEGLAB as administrator.





  
  

  49
  





  
  

  50
  
# Documentation:





  
  

  51
  





  
  

  52
  
EEGLAB documentation is available on the EEGLAB wiki (see http://sccn.ucsd.edu/wiki/EEGLAB_Wiki for more details).