search

NeuroTechX / EEG-ExPy

EEG Experiments in Python
https://neurotechx.github.io/EEG-ExPy/
BSD 3-Clause "New" or "Revised" License
418 stars 124 forks source link

major update: merging develop to master #217

Closed JohnGriffiths closed 1 year ago

JohnGriffiths commented 1 year ago

As discussed here, we are just about ready to merge the develop branch to master, and in the process adopt a more formalized release schedule.

Since its fork from master develop has accrued two major updates and several smaller tweaks.

The major updates had major contributions by @Parvfect in his GSoC work. They are:

  1. The experiments class refactor. The main piece of this was to create an Experiment Base Class, and to subclass from this for specific experiment instantiations. ( Note that the switch to the base class has not yet been implemented for all experiments. )

  2. The analysis report function. This runs the minimal analysis pipeline used in most notebook examples as a self-contained function and cli one-liner, and also generates an HTML page with the outputs.

We used the develop branch for the EEG workshop run in the fall last year, which used all of the main supported devices (muse, openbci, neurosity, gtec ), and did not encounter any issues. So the code should be sufficiently tested at this point to make this merge acceptable.

There are a number of gaps in the docs on the above that we will not aim to address with this merge, but should be added with minor release updates soon.

JohnGriffiths commented 1 year ago

note: @Parvfect will add a small additional PR very shortly, updating the experiments example docs