Installation

Requirements

  • Python 3.6 or newer version
  • Visual Studio 2015 community edition (only Windows)

How to install

Windows

On a Windows machine, Explorepy can be installed using the installable file uploaded in the release page or using pip. Please note using the installable files, the dependencies will be installed automatically.

The following instructions guides you to install Explorepy API using pip with all its dependencies on Windows.

  1. Install Python 3 on your computer. It is recommended to install Anaconda Python package. Download and install Anaconda Python 3.7 Windows installer from here.
  2. Download and install MS Visual Studio Community Edition 2015 from this link. You may need to sign in to your Microsoft account to be able to download it. During the installation, select custom installation and in the features list make sure you check Common tools for Visual C++ 2015 under Visual C++ section and Python tools for Visual Studio (January 2017).
  3. We recommend using a virtual environment.
  • In Conda command prompt: conda create -n myenv python=3.6
  • Activate the virtual environment: conda activate myenv
  1. Upgrade your pip: python -m pip install --upgrade pip
  2. To install explorepy from PyPI run: pip install explorepy

Ubuntu

  1. Install Bluetooth header files using sudo apt-get install libbluetooth-dev
  2. It is recommended to install Anaconda Python package. Download and install Anaconda Python 3.7 Ubuntu installer from here.
  3. We recommend using a virtual environment in Conda.
  • In Conda command prompt: conda create -n myenv python=3.6
  • Activate the virtual environment: conda activate myenv
  1. Upgrade your pip: python -m pip install --upgrade pip
  2. To install explorepy from PyPI run: pip install explorepy

Mac

1. Install XCode from Mac App store. An upgrade to the latest version of MacOS might be required for installation of XCode. For older versions of MacOS, you can find compatible versions of XCode in this page. All old Xcode versions are available in this link.

  1. Accept the license agreement: sudo xcodebuild -license
  2. It is recommended to install Anaconda Python package. Download and install Anaconda Python 3.7 Mac installer from here. For older versions of MacOS, compatible version of Anaconda can be found in this table and can be downloaded from here.
  3. We recommend using a virtual environment in Conda.
  • In Conda command prompt: conda create -n myenv python=3.6
  • Activate the virtual environment: conda activate myenv
  1. Upgrade your pip: python -m pip install --upgrade pip
  2. To install explorepy from PyPI run: pip install explorepy

Quick test

  • Open Conda command prompt
  • Activate the virtual environment: conda activate myenv
  • explorepy visualize -n <YOUR-DEVICE-NAME> -lf 1 -hf 40
  • To stop visualization press Ctrl+c

Troubleshooting

1. Pylsl import issue

    self._handle = _dlopen(self._name, mode)
OSError: [WinError 126] The specified module could not be found

To fix this problem, an older version of Pylsl can be installed using this command:

pip install pylsl==1.13.1

Alternatively, MS Visual C++ redistributable (vc_redist) can be installed via this download page.

2. Anaconda asyncio events library raises “NotImplementedError” error in Windows

File "c:\users\jose\anaconda3\lib\site-packages\bokeh\server\server.py", line 407, in __init__
    http_server.add_sockets(sockets)
File "c:\users\jose\anaconda3\lib\site-packages\tornado\tcpserver.py", line 165, in add_sockets
    self._handlers[sock.fileno()] = add_accept_handler(
File "c:\users\jose\anaconda3\lib\site-packages\tornado\netutil.py", line 279, in add_accept_handler
    io_loop.add_handler(sock, accept_handler, IOLoop.READ)
File "c:\users\jose\anaconda3\lib\site-packages\tornado\platform\asyncio.py", line 100, in add_handler
    self.asyncio_loop.add_reader(fd, self._handle_events, fd, IOLoop.READ)
File "c:\users\jose\anaconda3\lib\asyncio\events.py", line 501, in add_reader
    raise NotImplementedError

Solution: Downgrade Anaconda distribution version to one of 3.5, 3.6 or 3.7 versions.

3. btScan file does not exist error on Mac OS

Solution: Change the permission of the file btScan from terminal using

chmod +x btScan

The btScan file would be in the site packages folder in anaconda distribution. To find out the actual location the files installed by explorepy, type “which explorepy” in terminal.

4. No module named ‘numpy’

ERROR: Command errored out with exit status 4294967295:
 command: 'C:\Users\mh\Anaconda3\envs\test130_38\python.exe' -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'C:\\Users\\mh_at\\AppData\\Local\\Temp\\pip-install-6fpsl7b1\\pyedflib_e1c2dcc3a4dc46af9468c24083cbda2b\\setup.py'"'"'; __file__='"'"'C:\\Users\\mh_at\\AppData\\Local\\Temp\\pip-install-6fpsl7b1\\pyedflib_e1c2dcc3a4dc46af9468c24083cbda2b\\setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base 'C:\Users\mh_at\AppData\Local\Temp\pip-pip-egg-info-48yn2fu3'
     cwd: C:\Users\mh\AppData\Local\Temp\pip-install-6fpsl7b1\pyedflib_e1c2dcc3a4dc46af9468c24083cbda2b\
Complete output (4 lines):
No module named 'numpy'
*** package "numpy" not found ***
pyEDFlib requires a version of NumPy, even for setup.
Please get it from http://numpy.scipy.org/ or install it through your package manager.
----------------------------------------
ERROR: Command errored out with exit status 4294967295: python setup.py egg_info Check the logs for full command output.

Solution: To fix this error, install numpy separately by pip install numpy and then install explorepy.