Installation

This toolbox is built using primarily eelbrain. The following guide will walk you through how to install and set up the Python environment for the toolbox.

Step 1. Install Mamba

We use mamba to create and manage the environment.

The recommended way to get mamba is to use Miniforge:

1. Go to the Miniforge download page
2. Download for your operating system (Windows, macOS, or Linux). For Windows, just run the installer .exe and accept the default options during installation. For macOS, open the Terminal, navigate to the folder where the installer .sh file is saved (cd PATH/TO/THE/FOLDER), and run:

./Miniforge3-MacOSX-arm64.sh

Alternatively, if you already have Anaconda installed, you may also install mamba into the base environment from conda-forge (however, solving the environments may take a long time, so this is not recommended):

conda install -n base -c conda-forge mamba

You can verify mamba installation by running:

mamba --version

Step 2. Download repository

Download the Gitbub repository of the toolbox and unzip it. Inside, you should see a folder called "neuraspeech" and documents like README.md, requirements.yml, etc.

Step 3: Create environment

Open Terminal or Miniforge/Anaconda Prompt, navigate to the directory of that folder, and then run:

mamba env create -f environment.yml

This will create a Python environment called "neuraspeech" with required dependencies installed. You can activate this environment in the prompt or terminal using:

mamba activate neuraspeech

If you're using a code editor like VS Code, you can choose the installed environment by selecting its name in the top right corner.