Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #423

Merged
merged 4 commits into from
Aug 3, 2016
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 155 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,164 @@
## README for the Neural Simulation Tool NEST [![Build Status](https://travis-ci.org/nest/nest-simulator.svg?branch=master)](https://travis-ci.org/nest/nest-simulator)
Generic installation instructions can be found in the file INSTALL that
you received with the NEST sources.
# The Neural Simulation Tool - NEST [![Build Status](https://travis-ci.org/nest/nest-simulator.svg?branch=master)](https://travis-ci.org/nest/nest-simulator)

Inside NEST, you can run the command `help` to find documentation and
learn more about the available commands.
NEST is a simulator for spiking neural network models that focuses on the
dynamics, size and structure of neural systems rather than on the exact
morphology of individual neurons. The development of NEST is coordinated by the
NEST Initiative. General information on the NEST Initiative, can be found at
it's homepage at http://www.nest-initiative.org.

Please see `${prefix}/share/doc/nest/README.md` for information about
the Python bindings to NEST.
NEST is ideal for networks of spiking neurons of any size, for example:

For information on the NEST Initiative, please visit it's homepage at
http://www.nest-initiative.org
- Models of information processing e.g. in the visual or auditory cortex of
mammals,
- Models of network activity dynamics, e.g. laminar cortical networks or
balanced random networks,
- Models of learning and plasticity.

For copyright information please refer to the file LICENSE and to the
For copyright information please refer to the LICENSE file and to the
information header in the source files.

## How do I use NEST?

You can use NEST either via Python (PyNEST) or as a stand alone application
(nest). PyNEST provides a set of commands to the Python interpreter which give
you access to NEST's simulation kernel. With these commands, you describe and
run your network simulation. You can also complement PyNEST with PyNN, a
simulator-independent set of Python commands to formulate and run neural
simulations. While you define your simulations in Python, the actual simulation
is executed within NEST's highly optimized simulation kernel which is written
in C++.

A NEST simulation tries to follow the logic of an electrophysiological
experiment that takes place inside a computer with the difference, that the
neural system to be investigated must be defined by the experimenter.

The neural system is defined by a possibly large number of neurons and their
connections. In a NEST network, different neuron and synapse models can
coexist. Any two neurons can have multiple connections with different
properties. Thus, the connectivity can in general not be described by a weight
or connectivity matrix but rather as an adjacency list.

To manipulate or observe the network dynamics, the experimenter can define
so-called devices which represent the various instruments (for measuring and
stimulation) found in an experiment. These devices write their data either to
memory or to file.

NEST is extensible and new models for neurons, synapses, and devices can be
added.

To get started with NEST, please see the [Documentation Page for
Tutorials](http://nest-simulator.org/documentation/).

## Why should I use NEST?

To learn more about the capabilities of NEST, please read the complete [feature
summary](http://nest-simulator.org/features/).

- NEST provides over 50 neuron models many of which have been published. Choose
from simple integrate-and-fire neurons with current or conductance based
synapses, over the Izhikevich or AdEx models, to Hodgkin-Huxley models.
- NEST provides over 10 synapse models, including short-term plasticity
(Tsodyks & Markram) and different variants of spike-timing dependent
plasticity (STDP).
- NEST provides many examples that help you getting started with your own
simulation project.
- NEST offers convenient and efficient commands to define and connect large
networks, ranging from algorithmically determined connections to data-driven
connectivity.
- NEST lets you inspect and modify the state of each neuron and each connection
at any time during a simulation.
- NEST is fast and memory efficient. It makes best use of your multi-core
computer and compute clusters with minimal user intervention.
- NEST runs on a wide range of UNIX-like systems, from MacBooks to BlueGene
supercomputers.
- NEST has minimal dependencies. All it really needs is a C++ compiler.
Everything else is optional.
- NEST developers are using agile continuous integration-based workflows in
order to maintain high code quality standards for correct and reproducible
simulations.
- NEST has one of the largest and most experienced developer communities of all
neural simulators. NEST was first released in 1994 under the name SYNOD and
has been extended and improved ever since.
- NEST is open source software and is licensed under the GNU General Public
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make the licensing information a section of its own for better visibility.

License v2 or later.

## Installing NEST

Generic installation instructions can be found in the
[INSTALL](https://github.com/nest/nest-simulator/blob/master/INSTALL) file that
you received in the NEST sources.

## Getting help

- You can run the `help` command in the NEST interpreter to find documentation
and learn more about available commands.
- For queries regarding NEST usage, please use the [nest-users mailing
list](http://mail.nest-initiative.org/cgi-bin/mailman/listinfo/nest_user).
- Information on the Python bindings to NEST can be found in
`${prefix}/share/doc/nest/README.md`.
- For those looking to extend NEST a [developer
manual](http://nest.github.io/nest-simulator/) is available.

## Citing NEST

Please cite NEST if you use it in your work. If you use this version of NEST,
please cite it as `Bos, Hannah et al. (2015). NEST 2.10.0. Zenodo.
10.5281/zenodo.44222`. The full citation is available in different formats on
[Zenodo](http://dx.doi.org/10.5281/zenodo.44222).

Here is a suitable BibTeX entry:

```latex
@misc{bos_2015_44222,
author = {Bos, Hannah and
Morrison, Abigail and
Peyser, Alexander and
Hahne, Jan and
Helias, Moritz and
Kunkel, Susanne and
Ippen, Tammo and
Eppler, Jochen Martin and
Schmidt, Maximilian and
Seeholzer, Alex and
Djurfeldt, Mikael and
Diaz, Sandra and
Morén, Janne and
Deepu, Rajalekshmi and
Stocco, Teo and
Deger, Moritz and
Michler, Frank and
Plesser, Hans Ekkehard},
title = {NEST 2.10.0},
month = dec,
year = 2015,
doi = {10.5281/zenodo.44222},
url = {http://dx.doi.org/10.5281/zenodo.44222}
}
```

For all other versions below NEST v2.8.0 please use: [Gewaltig M-O & Diesmann M
(2007) NEST (Neural Simulation Tool) Scholarpedia
2(4):1430](http://www.scholarpedia.org/article/NEST_(Neural_Simulation_Tool)).

Here is a suitable BibTeX entry:

```latex
@ARTICLE{Gewaltig:NEST,
author = {Marc-Oliver Gewaltig and Markus Diesmann},
title = {NEST (NEural Simulation Tool)},
journal = {Scholarpedia},
year = {2007},
volume = {2},
pages = {1430},
number = {4}
}
```

Please get in touch with us about your publications that used NEST, we will add
it to our publication list, thus making it visible to potential readers.

## Editor support

Emacs users may use the SLI mode, which provides syntax highlighting
for SLI. To install it, add the following lines to your `.emacs` file:
```
Expand Down