Skip to content

sappelhoff/eeg_positions

Repository files navigation

Python build Python tests Test coverage Documentation status PyPi version Conda version Zenodo archive

eeg_positions

Compute and plot standard EEG electrode positions.

Please see the Documentation.

Quickstart

There are two common ways to make use of this repository:

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

  2. Use eeg_positions as a Python package (install instructions below), and then obtain the EEG electrode positions through the get_elec_coords function. See the Examples and API documentation.

Installation

For installing the stable version of eeg_positions, call:

python -m pip install --upgrade eeg_positions

Or if you use conda:

conda install --channel conda-forge eeg_positions

For installing the latest (development) version of eeg_positions, call:

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.