Installation¶
Hint
Spotted a typo? Would like to add something or make a correction? Join us by contributing (see these guides).
1. Python¶
Windows¶
Winpython¶
The advantage of Winpython is its portability (i.e., works out of a folder) and default setup (convenient for science).
Download a non-zero version of Winpython
Install it somewhere (the desktop is a good place). It creates a folder called WPyXX-xxxx
In the WPyXX-xxxx folder, open WinPython Command Prompt.exe
Run
pip install https://github.com/neuropsychology/NeuroKit/zipball/master
Start Spyder.exe
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.
Download and install Miniconda or Anaconda (make sure the
Anaconda3
directory is similar to this:C:\Users\<username>\anaconda3\
)Open the Anaconda Prompt (search for it on your computer)
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.
Run
conda env create <yourenvname>
; activate it every time you open up conda by runningconda activate <yourenvname>
Is pip (package installer for python) installed in this env? Prompt Anaconda using
pip list
it’ll show you all the packages installed in that conda env
2. NeuroKit¶
If you already have python, you can install NeuroKit by running this command in your terminal:
pip install neurokit2
This is the preferred method to install NeuroKit, as it will always install the most stable release. It is also possible to install it 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 some work-in-progress features using pip install https://github.com/neuropsychology/neurokit/zipball/dev
If you don’t have pip installed, this Python installation guide can guide you through the process.