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

Update README on GitHub #3277

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from all 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
141 changes: 56 additions & 85 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,110 +22,81 @@

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
its homepage at https://www.nest-initiative.org.
morphology of individual neurons.

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.

NEST is ideal for networks of spiking neurons of any size, for example:

- Models of information processing e.g. in the visual or auditory cortex of
- 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
- 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 `LICENSE` file and to the
information header in the source files.
## Key features of NEST

## How do I use NEST?
* NEST provides a Python interface or a stand-alone application
* NEST provides a large collection of [neurons and synapse models](https://nest-simulator.org/documentation/models/index.html)
* NEST provides numerous [example network scripts](https://nest-simulator.org/documentation/examples/index.html) along with
[tutorials and guides](https://nest-simulator.org/documentation/get-started_index.html) to help you develop your simulation
* NEST has a large community of experienced developers and users; NEST was first released in 1994 under the name SYNOD, and has been extended and improved ever since
* NEST is extensible: you can extend NEST by adding your own modules
* NEST is scalable: Use NEST on your laptop or the largest supercomputers
* NEST is memory efficient: It makes the best use of your multi-core computer and compute clusters with minimal user intervention
* NEST is an open source project and is licensed under the GNU General Public License v2 or later
* NEST employs continuous integration workflows in order to maintain high code quality standards for correct and reproducible simulations

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.
## Documentation

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](https://www.nest-simulator.org/documentation/).

## Why should I use NEST?

To learn more about the capabilities of NEST, please read the complete [feature
summary](https://www.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
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.
Please visit our [online documentation](https://nest-simulator.org/documentation) for details on installing and using NEST.

## License

NEST is open source software and is licensed under the [GNU General Public
License v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) or
later.
## Cite NEST

If you use NEST as part of your research, please cite the *version* of NEST you used.
The full citation for each release can be found on [Zenodo](https://zenodo.org/search?q=title%3ANEST%20AND%20-description%3Agraphical%20AND%20simulator&l=list&p=1&s=10&sort=publication-desc)

For general citations, please use

`Gewaltig M-O & Diesmann M (2007) NEST (Neural Simulation Tool) Scholarpedia 2(4):1430.`

## Contact

## Installing NEST

Please see the online [NEST Installation Instructions](http://www.nest-simulator.org/installation)
to find out how to install NEST.
If you need help or would like to discuss an idea or issue,
join our [maling list](https://nest-simulator.org/documenation/developer_space/guidelines/mailing_list_guidelines.html),
where we encourage active participation from our developers and users to share their knowledge and experience with NEST.

## 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](https://www.nest-initiative.org/mailinglist/).
- Information on the Python bindings to NEST can be found in
`${prefix}/share/doc/nest/README.md`.
- For those looking to extend NEST, developer documentation on [Contributing to
NEST](https://nest-simulator.readthedocs.io/en/latest/contribute/index.html) is available.
You can find other [ways to get in touch here](https://nest-simulator.readthedocs.io/en/stable/community.html).

## Citing NEST

Please cite NEST if you use it in your work.
## Contribute

- You can find all the information for [citing NEST here](https://nest-simulator.readthedocs.io/en/latest/citing-nest.html)
NEST is built on an active community and we welcome contributions to our code and documentation.


For bug reports, feature requests, documentation improvements, or other issues,
you can create a [GitHub issue](https://github.com/nest/nest-simulator/issues/new/choose),

For working with NEST code and documentation, you can find guidelines for contributions
[in our documentation](https://nest-simulator.readthedocs.io/en/stable/developer_space/index.html#contribute-to-nest)


## Publications

You can find a list of NEST [related publications here](https://www.nest-simulator.org/publications/).

## License


NEST is open source software and is licensed under the [GNU General Public
License v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) or
later.

General information on the NEST Initiative can be found at
its homepage at https://www.nest-initiative.org.
Loading