eeg_positions

eeg_positions

Compute and plot standard EEG electrode positions on a spherical head model.

Check out the Documentation for more details.

Quickstart

There are two common ways to use this repository:

1. Go to the data/ directory and download the EEG electrode position files you need (see the corresponding README).

2. Use eeg_positions as a Python package (install instructions below), and then obtain the EEG electrode positions through the get_elec_coords function. Check out the examples and API documentation for more details.

Note on MNE-Python integration: The idealized spherical montages computed by this package (spherical_1005, spherical_1010, and spherical_1020) are shipped directly in MNE-Python via mne.channels.make_standard_montage (added in mne-tools/mne-python#13903).

Installation

To install the stable version of eeg_positions, use:

python -m pip install --upgrade eeg_positions

Or if you use conda:

conda install --channel conda-forge eeg_positions

To install the latest development version of eeg_positions, use:

python -m pip install --upgrade https://github.com/sappelhoff/eeg_positions/archive/refs/heads/main.zip

Contributing

The development of eeg_positions is taking place on GitHub.

For more information, please see CONTRIBUTING.md.

Cite

If you find this repository useful and want to cite it in your work, please go to the Zenodo record and obtain the appropriate citation from the “Cite as” section there.