Skip to content

Improve and tighten up README documentation for clarity, structure, and conciseness #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JohnGriffiths wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve and tighten up README documentation for clarity, structure, and conciseness #319

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 18 additions & 21 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,55 +36,52 @@ EEG-ExPy is a collection of classic EEG experiments, implemented in Python. The
Overview
--------

Conventional lab-based EEG research typically uses research-grade (often high-density) EEG devices, dedicated stimulus delivery software and hardware, and dedicated technicians responsible for operating this equipment. The price tag for these items can easily extend into hundreds of thousands of dollars, which naturally places major limits on their acquisition and usage.
EEG-ExPy enables classic EEG cognitive neuroscience experiments using affordable, consumer-grade EEG devices and a standard computer. This makes cognitive neuroscience and neurotechnology accessible for education, research, and clinical applications outside traditional labs.

In recent years, however, developments in hardware and software technologies are making it possible for many classic EEG cognitive neuroscience experiments to be conducted using a standard laptop/personal computer and a relatively cheap consumer-grade EEG device, with a combined minimum cost of less than 1000 dollars. This opens dramatic new possibilities for neurotechnology and cognitive neuroscience *education* (at both University and High School levels), as well as more ambitious and larger-scale *research* and *clinical* applications using large numbers of devices, and/or in more naturalistic (i.e. out-of-the-lab) settings. We like to think of this as contributing to the *democratization of the cognitive neuroscience experiment*.
The project provides:

The core aim of the EEG-Notebooks project is to provide the critical 'glue' that pulls together the various enabling technologies necessary for running these experiments and analyzing the data. This includes functionality for
* Streaming from various wireless consumer-grade EEG devices
* Visual and auditory stimulus presentation, time-locked to EEG recordings
* A growing library of well-documented, ready-to-use experiments
* Signal processing, statistical, and machine learning analysis tools

* streaming data from various relatively new wireless consumer-grade EEG devices
* visual and auditory stimulus presentation, concurrent with and time-locked to the EEG recordings
* a growing library of well-documented, ready-to-use, and ready-to-modify experiments
* signal processing, statistical, and machine learning data analysis functionalities

A real one-stop-shop!

For more discussion on these social/scientific/technological contexts and trajectories, a) feel free to get in touch directly (see #Contact info below) and b) keep an eye out for the forthcoming eeg-expy research paper.
EEG-ExPy is your one-stop shop for accessible cognitive neuroscience experiments.


Documentation
-------------

The current version of eeg-expy is the 0.2.X series. The code-base and API are under major development and subject to change.
The current version is 0.2.X. The codebase and API are under active development and may change.

Check the `changelog <https://neurotechx.github.io/EEG-ExPy/changelog.html>`_ for notes on changes from previous versions.
See the `changelog <https://neurotechx.github.io/EEG-ExPy/changelog.html>`_ for recent updates.

**Installation instructions**, steps for **getting started**, common **troubleshooting** solutions and more can be found in the documentation for eeg-expy, available on the
**Full documentation**, including installation, getting started, and troubleshooting, is available at the
`documentation site <https://neurotechx.github.io/EEG-ExPy/index.html>`_.

Acknowledgments
----------------

EEG-Notebooks was created by the `NeurotechX <https://neurotechx.com/>`_ hacker/developer/neuroscience community. The ininitial idea and majority of the groundwork was due to Alexandre Barachant - including the `muse-lsl <https://github.com/alexandrebarachant/muse-lsl/>`_ library, which is core dependency. Lead developer on the project is now `John Griffiths <https://www.grifflab.com>`_ .
EEG-ExPy was created by the `NeurotechX <https://neurotechx.com/>`_ hacker/developer/neuroscience community. The initial idea and majority of the groundwork was due to Alexandre Barachant—including the `muse-lsl <https://github.com/alexandrebarachant/muse-lsl/>`_ library, a core dependency. The current lead developer is `John Griffiths <https://www.grifflab.com>`_.

Key contributors include: Alexandre Barachant, Hubert Banville, Dano Morrison, Ben Shapiro, John Griffiths, Amanda Easson, Kyle Mathewson, Jadin Tredup, Erik Bjäreholt.
Key contributors: Alexandre Barachant, Hubert Banville, Dano Morrison, Ben Shapiro, John Griffiths, Amanda Easson, Kyle Mathewson, Jadin Tredup, Erik Bjäreholt.

Thanks also to Andrey Parfenov for the excellent `brainflow <https://github.com/brainflow-dev/brainflow/>`_ library, which has allowed us to dramatically expand the range of supported devices; as well as the developers of `PsychoPy <https://github.com/psychopy/psychopy/>`_ and `MNE <https://github.com/mne-tools/mne-python/>`_, which together make up the central scaffolding of eeg-expy.
Special thanks to Andrey Parfenov for the excellent `brainflow <https://github.com/brainflow-dev/brainflow/>`_ library, and to the developers of `PsychoPy <https://github.com/psychopy/psychopy/>`_ and `MNE <https://github.com/mne-tools/mne-python/>`_, which are central to EEG-ExPy.


Contribute
----------

This project welcomes and encourages contributions from the community!
We welcome and encourage community contributions!

If you have an idea of something to add to eeg-expy, please start by opening an
To suggest features or report bugs, please open an
`issue <https://github.com/NeuroTechX/eeg-expy/issues/new/choose>`_.


Contact
-------------
-------

The best place for general discussion on eeg-expy functionality is the `issues page <https://github.com/NeuroTechX/eeg-expy/issues/new/choose>`_. For more general questions and discussions, you can e-mail `john.griffiths@utoronto.ca`, or ping us on the `NeuroTechX Discord <https://discord.gg/zYCBfBf4W4>`_ or `NeuroTechX slack <https://neurotechx.herokuapp.com>`_.
For general discussion, use the `issues page <https://github.com/NeuroTechX/eeg-expy/issues/new/choose>`_.
Copy link

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link labeled "issues page" points to the issue template chooser (/issues/new/choose), which is for creating a new issue rather than viewing/participating in ongoing discussion. Consider linking to the repository issues list (/issues) (or GitHub Discussions if that’s what you intend) so the text and destination match.

Suggested change
For general discussion, use the `issues page <https://github.com/NeuroTechX/eeg-expy/issues/new/choose>`_.
For general discussion, use the `issues page <https://github.com/NeuroTechX/eeg-expy/issues>`_.

Copilot uses AI. Check for mistakes.
For questions, email `john.griffiths@utoronto.ca`, or join us on the `NeuroTechX Discord <https://discord.gg/zYCBfBf4W4>`_ or `NeuroTechX Slack <https://neurotechx.herokuapp.com>`_.



Expand Down
Loading