Installation

Hint

Spotted a typo? Would like to add something or make a correction? Join us by contributing (see these guides).

Instructions for users without a Python installation

Since NeuroKit2 is a Python package, let’s first make sure that you have a Python installation on your computing device. Then we can move on to install the NeuroKit2 package itself.

Windows

Winpython

The advantage of Winpython is its portability (i.e., works out of a folder) and default setup (convenient for science).

  1. Download a non-zero version of Winpython

  2. Install it somewhere (the desktop is a good place). It creates a folder called WPyXX-xxxx

  3. In the WPyXX-xxxx folder, open WinPython Command Prompt.exe

  4. Now you can proceed to install the NeuroKit2 package

Miniconda or Anaconda

The difference between the two is straightforward, miniconda is recommended if you don’t have much storage space and you know what you want to install. Similar to Winpython, Anaconda comes with a base environment, meaning you have basic packages pre-installed. Here is some more information to help you choose between miniconda and Anaconda.

  1. Download and install Miniconda or Anaconda (make sure the Anaconda3 directory is similar to this: C:\Users\<username>\anaconda3\)

  2. Open the Anaconda Prompt (search for it on your computer)

  3. Run conda help to see your options

Note

There should be a name in parentheses before your user’s directory, e.g. (base) C:\Users\<yourusername>. That is the name of your computing environment. By default, you have a base environment. We don’t want that, so create an environment.

  1. Run conda env create <yourenvname>; activate it every time you open up conda by running conda activate <yourenvname>

  2. Now you can proceed to install the NeuroKit2 package

https://raw.github.com/neuropsychology/Neurokit/master/docs/img/tutorial_installation_conda.jpg

Mac OS

  1. Install Anaconda

  2. Open the terminal

  3. Run source activate root

Instructions for users with a Python installation

If you have Python installed as part of Miniconda or Anaconda, please follow these steps:

  1. As described in above, open the Anaconda Prompt and activate your conda environment

  2. You can now install NeuroKit2 from conda-forge by typing

conda config --add channels conda-forge
conda install neurokit2

If you use another Python installation, you can simply install NeuroKit2 from PyPI:

pip install neurokit2

If you don’t have pip installed, this Python installation guide can guide you through the process.

conda or pip are the preferred methods to install NeuroKit2, as they will install the most up-to-date stable release.

It is also possible to install NeuroKit2 directly from GitHub:

pip install https://github.com/neuropsychology/neurokit/zipball/master

Hint

Enjoy living on the edge? You can always install the latest dev branch to access work-in-progress features using pip install https://github.com/neuropsychology/neurokit/zipball/dev