Source Code Layout

From NEST

The source code of NEST is split in several directories:

doc

The documentation of NEST. This includes design documents and user documentation. The online help is generated during the installation of NEST and installed to the installation directory. We use doxygen comments extensively throughout NEST. make doc will extract it from the source code and install it to the doc directory.

examples

Examples for the usage of SLI and NEST. The examples for PyNEST can be found in the pynest directory. All examples are installed to the directory $prefix/share/doc/nest/examples.

extras

This directory contains several helper scripts for running NEST in a distributed setup (nest_serial and nest_indirect), some patches that are used during the installation process on different architectures, and the SLI mode for emacs.

include

lib

The library files for SLI and NEST. This includes the startup-files and SLI-wrappers for built-in functions.

libltdl

libnestutil

librandom

models

The synapse, device, and neuron models for grid-based simulations with NEST.

nest

This directory contains the code to build the nest executable. Basically main.cpp just collects all necessary modules and links the executable against the necessary libraries.

nestkernel

precise

The synapse, device, and neuron models for precise timing simulations with NEST.

pynest

sli

The integrated simulation language interpreter.

testsuite

topology