Installation

Minimal Requirements

  • Python 3.10 to Python 3.12

  • Microsoft Build Tools for Visual Studio 2019 (only Windows)

  • 6GB RAM (minimum 1GB free RAM during the session)

  • Intel i5 or higher (2x2.5GHz) CPU

How to install

Windows

Option 1: Installing via installer file (basic)

This option is best for users who only intend to use explorepy via graphical user interface

For example, if you want to quickly visualize and record data, use Option 1. If you intend to add explorepy commands to a Python script (e.g. an experiment script), install explorepy via Anaconda instead.

For an overview of explorepy commands, click here.

On a Windows and Mac operating systems, standalone desktop software explorepy-desktop can be installed using the .exe installable file uploaded to release page. Please note that the dependencies will be installed automatically.

Option 2: Installing from Python Package Index (PyPI) and pip (advanced)

This option is best for users who intend to include explorepy functionalities in their own Python scripts.

To install the explorepy API and all its dependencies using pip on Windows:

  1. Install Anaconda (or any other Python distribution; these instructions pertain to Anaconda only). Download and install the Anaconda Windows installer.

  2. Install Microsoft Build Tools for Visual Studio 2019. Select Desktop development with C++ in the workloads tab. Make sure that MSVCv142 - VS 2019 C++ x64/x86 build tools and the latest version of Windows 10 SDK are checked.

  3. Open the Conda command prompt.

  4. We recommend using a virtual environment. To do this:

    1. In Conda command prompt: conda create -n myenv python=3.10

    2. Activate the virtual environment: conda activate myenv

  5. Upgrade your pip: python -m pip install --upgrade pip

  6. Run: pip install explorepy, to install explorepy from PyPI.

Ubuntu

  1. From Linux Terminal, run these commands one by one: sudo apt-get install libbluetooth-dev and sudo apt-get install build-essential and conda install -c conda-forge liblsl.

  2. We recommend installing Anaconda. Download and installer Anaconda<https://www.anaconda.com/download>/Miniconda/.

  3. We recommend using a virtual environment in Conda. To do this:

    1. In Conda command prompt: conda create -n myenv python=3.10

    2. Activate the virtual environment: conda activate myenv

  4. Upgrade your pip: python -m pip install --upgrade pip

  5. Run: pip install explorepy, to install explorepy from PyPI.

  6. From Linux Terminal, run: sudo apt install libxcb-cursor0

Mac

  1. Install XCode from the Mac App store. For this, you may need to upgrade to the latest version of MacOS. For older versions of MacOS, find compatible versions of XCode here. All old XCode versions are available here.

  2. Accept the license agreement: sudo xcodebuild -license

  3. Download and installer Anaconda<https://www.anaconda.com/download>/Miniconda/.

  4. We recommend using a virtual environment in Conda.

    1. In Conda command prompt: conda create -n myenv python=3.10

    2. Activate the virtual environment: conda activate myenv

  5. Upgrade your pip: python -m pip install --upgrade pip

  6. Run: pip install explorepy, to install explorepy from PyPI.

  7. Connect your Explore device from Mac Bluetooth menu and run your Python script.

Quick test

  • Open the Conda command prompt (if you used pip) or Windows command prompt (if you used the installable file).

  • Activate the virtual environment (this step is only necessary in the Conda command prompt): conda activate myenv

  • Run explorepy acquire -n DEVICE-NAME

  • To stop the command execution, press Ctrl+C

Troubleshooting

1. OSError: A socket operation was attempted to an unreachable network.

Solution: Ensure that your Explore device is paired with your computer and try again.

2. ValueError: Error opening socket.

Solution: Ensure the Bluetooth module of your computer’s operating system is on and working.

3. OSError: The handle is invalid.

Solution: Ensure the Bluetooth module of your computer’s operating system is on and working.

If your issue persists, please send a screenshot and brief error description to support@mentalab.com, and we will quickly help you solve it.