search

LMBooth / pybci

Create real-time BCI's with the LSL, PyTorch, SKLearn and TensorFlow packages.
https://pybci.readthedocs.io/en/latest/
MIT License
22 stars 4 forks source link

Installation process suggestions #8

Closed jsheunis closed 1 year ago

jsheunis commented 1 year ago

I suggest adding the following to the readme and to the docs:

The use of a virtual environment for installing the package, e.g.:

python -m venv my_env
source my_env/bin/activate

followed by pip install

Installing from the source on github, for those wanting latest un-released features or for developers:

pip install git+https://github.com/LMBooth/pybci.git

or

git clone https://github.com/LMBooth/pybci.git
cd pybci
pip install -e .

Ping https://github.com/openjournals/joss-reviews/issues/5706

jsheunis commented 1 year ago

I also think, even though the minimum Python requirement is implicit in the setup.py code, it would be useful to state this explicitly in the docs, ideally in the Installation section.

LMBooth commented 1 year ago

Thankyou for these recommendation @jsheunis , i've made them and shall now close this issue. Please drop a comment or re-open if you find any related issues.