NeuroTechX / EEG-ExPy

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

Implement version + release schedule #216

Open JohnGriffiths opened 1 year ago

JohnGriffiths commented 1 year ago

(Note: general eegnb dev discussions to be relocated to github DIscussions on this page.

We are going to merge the develop branch to master, which contains two main new components: the refactored experiment class and the analysis report function.

As part of doing this, we will implement a more structured release schedule process, which will allow us to more easily keep on top of changes and comfortably execute releases / merge updates to master that might possibly cause backwards compatibility issues.

Overall tasks:

tmorshed commented 1 year ago

Problem: Regarding the first action item, we see that Develop fails building the docs.

Investigation: Started a new codespaces instance and checked it all. Still failed. The only thing that needed to be changed was the linux version. Seems like GH moved to Ubuntu 22.04 for actions since Nov. 2022 (which is around the time that this issue started).

Solution: Updating the version number of the wxpython wheel to 22.04. i.e.:

pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-18.04 wxPython

must become

pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-22.04 wxPython

Will try the update and see if it fixes the issue.

Update: No need to do this Turned out I was using Develop. the actual develop builds the docs okay. Ben's commit (on #210) has already fixed that.

Parvfect commented 1 year ago

Problem with respect to Docs

Docs tutorials for Running Experiments deal with importing individual experiements and then running them as per, image

However, with the Experiment Class Refactor #184, with classes and objects and such, the call changes slightly and will not work with the current code. Going to address this in a new pull request to master once the merge is done to fix the problem.