Skip to content

Commit

Permalink
update install docs (#278)
Browse files Browse the repository at this point in the history
* update install docs

* update refs to eeg-expy
  • Loading branch information
oreHGA authored Oct 23, 2024
1 parent b01997f commit 9221e27
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions doc/getting_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ As may be expected, the installation and setup steps for mode 2 are simpler than
Installing the Python library
===============================

We highly recommend making use of a virtual environment (either `conda` or `virtualenv`) when installing eeg-notebooks.
We highly recommend making use of a virtual environment (either `conda` or `virtualenv`) when installing eeg-expy.

If you don't already have a Python installation, grab the latest `miniconda` version for your operating system from here (https://docs.conda.io/en/latest/miniconda.html).

Expand All @@ -44,13 +44,13 @@ Use the following commands to download the repo, create and activate a conda or

.. code-block:: bash
conda create -n "eeg-notebooks" python=3.7 git pip wxpython
conda create -n "eeg-expy" python=3.8 git pip
conda activate "eeg-notebooks"
conda activate "eeg-expy"
git clone https://github.com/NeuroTechX/eeg-notebooks
git clone https://github.com/NeuroTechX/eeg-expy
cd eeg-notebooks
cd eeg-expy
pip install -e .
Expand All @@ -67,11 +67,11 @@ Use the following commands to download the repo, create and activate a conda or
python3 -m venv eegnb-env
git clone https://github.com/NeuroTechX/eeg-notebooks
git clone https://github.com/NeuroTechX/eeg-expy
eegnb-env\Scripts\activate.bat
cd eeg-notebooks
cd eeg-expy
pip install -e .
Expand All @@ -83,30 +83,30 @@ Use the following commands to download the repo, create and activate a conda or
python3 -m venv eegnb-env
git clone https://github.com/NeuroTechX/eeg-notebooks
git clone https://github.com/NeuroTechX/eeg-expy
source eegnb-env/bin/activate
cd eeg-notebooks
cd eeg-expy
pip install -e .
**Add the new environment to the jupyter kernel list**

For some operating systems, it is necessary the following command is necessary in order to make the new `eeg-notebooks` environment available from the jupyter notebook landing page
For some operating systems, it is necessary the following command is necessary in order to make the new `eeg-expy` environment available from the jupyter notebook landing page


.. code-block:: bash
python -m ipykernel install --user --name eeg-notebooks
python -m ipykernel install --user --name eeg-expy
**Test installation**

Start a jupyter notebooks session and you will be presented with the eeg-notebooks file structure. You can test the installation by opening a new jupyter notebook and running a cell containing the code below. This will run one session of the Visual N170 with your board of choice.
Start a jupyter notebooks session and you will be presented with the eeg-expy file structure. You can test the installation by opening a new jupyter notebook and running a cell containing the code below. This will run one session of the Visual N170 with your board of choice.

.. code-block:: python
Expand Down Expand Up @@ -153,7 +153,7 @@ BlueMuse is a Windows 10 program that allows communication between a Muse headba
MUSE recordings on Mac: BLED112 Dongle
---------------------------------------------

Unfortunately, the native bluetooth driver on Mac cannot be used with eeg-notebooks. To run on this operating system, it is necessary to purchase a `BLED112 USB Dongle <https://www.silabs.com/wireless/bluetooth/bluegiga-low-energy-legacy-modules/device.bled112/>`_. Note: this is a 'special' bluetooth dongle; standard bluetooth dongles will not work.
Unfortunately, the native bluetooth driver on Mac cannot be used with eeg-expy. To run on this operating system, it is necessary to purchase a `BLED112 USB Dongle <https://www.silabs.com/wireless/bluetooth/bluegiga-low-energy-legacy-modules/device.bled112/>`_. Note: this is a 'special' bluetooth dongle; standard bluetooth dongles will not work.


MUSE recordings on Linux
Expand All @@ -172,9 +172,9 @@ If you have created the conda env but it is not appearing as a kernel option in

.. code-block:: shell
$ conda activate eeg-notebooks
$ conda activate eeg-expy
$ pip install ipykernel
$ python -m ipykernel install --user --name eeg-notebooks
$ python -m ipykernel install --user --name eeg-expy
In windows, if the above is causing errors, the following commands may help:
Expand All @@ -190,7 +190,7 @@ In windows, if the above is causing errors, the following commands may help:
Bug reports
-----------

Please use the `Github issue tracker <https://github.com/neurotechx/eeg-notebooks/issues>`_
Please use the `Github issue tracker <https://github.com/neurotechx/eeg-expy/issues>`_
to file bug reports and/or ask questions about this project. When filing a bug report, please include the follwing information:
* Operating System.
* Device being used.
Expand Down

0 comments on commit 9221e27

Please sign in to comment.