To install NeuroElf, please download the current version from the main page (either the installer or flat folder/snapshot).

In case you downloaded the installer, unzip the archive to a temporary location, which contains to files:

• NeuroElf_vXY.m
• NeuroElf_vXY.mat

The .m file contains the code that unpacks the files from the .mat file within Matlab, runs some preliminary checks and, eventually, calls neuroelf_setup, which performs some of the setup tasks (e.g. compiling the MEX files if necessary and creating the file format cache). To install the toolbox, change the current directory in Matlab to the temporary folder where you unzipped the archive and then call the installing .m file with the -i input argument:

% change into folder containing installer
cd ~/Desktop
 
% call installer (in this case for version v0.9b)
NeuroElf_v09b -i

You will then be asked where to install the toolbox. Please make sure to choose a path/folder that is writable to the user(s) regularly using the toolbox!!

The folder into which the toolbox is installed will be added to Matlab path temporarily; in other words, if you wish to keep the toolbox on the path, please open the Path settings under File → Set Path… or, alternatively, issue the savepath command on the Matlab prompt.

In case the MEX files were not compiled on your platform and also not part of the installation package, please first read the page on MEX file compilation and, if that doesn't help, get in touch with me (see the error reporting page for instructions).

In case you downloaded the flat folder or snapshot archive, simply unzip this archive to its final destination. The archive contains one folder which is named according to the version of the toolbox, e.g. NeuroElf_v09b.

To finalize the installation, change into the installation folder in Matlab and issue the neuroelf_setup function manually:

% change into NeuroElf installation folder
cd /usr/local/matlab/toolbox/NeuroElf_v09b
 
% call NeuroElf's setup
neuroelf_setup

This time, you'll have to add the path manually and then save it, e.g. by issuing these commands:

neuroelf_addpath.m

% adding NeuroElf to the path and saving the altered path
addpath(neuroelf_path);
savepath;

• whereas many toolboxes require to add several folders to the path, NeuroElf only needs it main folder to be added
• the xff format files (text files that contain the instructions on how exactly to read/write different file formats) are parsed only once and the result is stored under _files/cache/cache.mat; it is thus important that this folder is writable to the toolbox (particularly when the format files are updated!)