Skip to content
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.

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

Add multiple installation options #263

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

JohnGriffiths
Copy link
Collaborator

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:

  • default ( pip install -e . )
  • streaming ( pip install -e .[streaming] )
  • stimpres ( pip install -e .[stimpres] )
  • docsbuild ( pip install -e .[docsbuild] )

Use cases for these options include:

  • Just want to do some quick lightweight dev without waiting 20 mins for psychopy to install
  • Want to do something on google colab (current installation doesn't work there; I think it fails on wxpython)
  • Want to do streaming but not stim pres
  • Want to test stim pres but don't need to do streaming
  • Want to test docs build but don't need to run any expts

etc etc

@tmorshed tmorshed mentioned this pull request Apr 4, 2024
moved click library to stim pres requirements section
@JohnGriffiths
Copy link
Collaborator Author

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]

oreHGA and others added 4 commits May 16, 2024 07:58
Co-authored-by: Taha Morshedzadeh <t.morshedzadeh@mail.utoronto.ca>
this does a full build with all dependencies for EEG-ExPy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants