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

Add multiple installation options #263

Closed JohnGriffiths closed 3 weeks ago

JohnGriffiths commented 3 months ago

Continuation and modification of #250

Adding support for multiple installation types

This is achieved primarily via adding some additional options in the requirements and setup files

It also necessitated splitting the analysis/utils.py file into analysis/streaming_utils.py and analysis/analysis_utils.py

so that e.g. an analysis-only install is not trying to do imports that are in the streaming requirements group

Further testing of each of these options is needed before merging

The instructions I'm following for this say that I can do the following pip install your_package[installtype]

since I'm usually doing

pip install -e .

for install, I believe this becomes

pip install -e .[installtype]

although I'm not entirely sure yet that this is doing what is intended

There are three install types:

Use cases for these options include:

etc etc

JohnGriffiths commented 1 month ago

And additionally, note - the way to recover the previous functionality of

pip install -e .

with this new configuration will be to do

pip install -e .[full]