This is A PREVIEW for NEST 3.0 and NOT an OFFICIAL RELEASE! Some functionality may not be available and information may be incomplete!
Installation from source¶
The following are the basic steps to compile and install NEST from source code:
If not already installed on your system, the following packages are recommended (see also the Dependencies section)
sudo apt-get install -y \ cython \ libgsl-dev \ libltdl-dev \ libncurses-dev \ libreadline-dev \ python-all-dev \ python-numpy \ python-scipy \ python-matplotlib \ python-nose \ openmpi-bin \ libopenmpi-dev
Unpack the tarball
tar -xzvf nest-simulator-x.y.z.tar.gz
Create a build directory:
Change to the build directory:
You may need additional
cmakeoptions and you can find the configuration options here.
cmake -DCMAKE_INSTALL_PREFIX:PATH=</install/path> </path/to/NEST/src>
/install/path should be an absolute path
Python bindings are enabled by default. Add the configuration option
-Dwith-python=OFF to disable them.
Compile and install NEST:
make make install make installcheck
NEST should now be successfully installed on your system. You should now be able to
import nest from a python or ipython shell.
If your operating system does not find the
nest executable or if Python does not find the
nest module, your path variables may not be set correctly. This may also be the case if Python cannot load the
nest module due to missing or incompatible libraries. In this case, please run:
to set the necessary environment variables. You may want to include this line in your
.bashrc file, so that the environment variables are set automatically.
NEST requires CMake 3.12 or higher, but we recommend version 3.16.X. You can type
cmake --version on the commandline to check your current version.
The GNU readline library is recommended if you use NEST interactively without Python. Although most Linux distributions have GNU readline installed, you still need to install its development package if want to use GNU readline with NEST. GNU readline itself depends on libncurses (or libtermcap on older systems). Again, the development packages are needed to compile NEST.
The GNU Scientific Library is needed by several neuron models, in particular those with conductance based synapses. If you want these models, please install the GNU Scientific Library along with its development packages.
If you want to use PyNEST, we recommend to install the following along with their development packages:
What gets installed where¶
By default, everything will be installed to the subdirectories
/install/path is the install path given to
If you want to run the
nest executable or use the
nest Python module without providing explicit paths, you have to add the installation directory to your search paths. For example, if you are using bash:
export PATH=$PATH:/install/path/bin export PYTHONPATH=/install/path/lib/pythonX.Y/site-packages:$PYTHONPATH
/install/path/bin/nest_vars.sh can be sourced in
.bashrc and will set these paths for you. This also allows to switch between NEST installations in a convenient manner.