-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
43 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,43 @@ | ||
# nest-desktop-AppImage | ||
An AppImage of NEST Desktop | ||
<p> | ||
<img src="https://raw.githubusercontent.com/nest-desktop/nest-desktop/v3.0/docs/_static/img/screenshots/start-page.png" /> | ||
</p> | ||
|
||
GitHub | ||
[![commit activity](https://img.shields.io/github/commit-activity/m/nest-desktop/nest-desktop)](https://github.com/nest-desktop/nest-desktop/commits/main) | ||
[![stars](https://img.shields.io/github/stars/nest-desktop/nest-desktop?style=social)](https://github.com/nest-desktop/nest-desktop/stargazers) | ||
[![forks](https://img.shields.io/github/forks/nest-desktop/nest-desktop?style=social)](https://github.com/nest-desktop/nest-desktop/network/members) | ||
|
||
[![docs](https://img.shields.io/readthedocs/nest-desktop)](https://nest-desktop.readthedocs.io) | ||
[![license](https://img.shields.io/github/license/nest-desktop/nest-desktop)](https://github.com/nest-desktop/nest-desktop/blob/main/LICENSE) | ||
[![DOI](https://img.shields.io/badge/DOI-10.1101%2F2021.06.15.444791-blue)](https://doi.org/10.1101/2021.06.15.444791) | ||
|
||
--- | ||
|
||
NEST Desktop is a graphical user interface for [NEST Simulator](https://nest-simulator.org). With this easy-to-use tool, users can interactively construct neuronal networks and explore network dynamics. | ||
The AppImage is a stand-alone application build with Electron framework. | ||
|
||
Advanced users often choose NEST Simulator: a prominent tool for spiking neuronal networks to measure network dynamics. | ||
However, programming knowledge is required to write code for this tool. | ||
NEST Desktop bypasses this requirement, but still teaches users how to construct and explore neuronal networks. | ||
A textual script is generated from the constructed networks and sent to NEST Simulator; | ||
the network activity is then visualized in a graph or table. | ||
It is a useful teaching tool, since the network graphs and network activity visualizations can be exported to files that users can implement for their course protocol. | ||
|
||
NEST Desktop is available on [EBRAINS](https://ebrains.eu/service/nest-desktop) (free EBRAINS account required). | ||
|
||
### Quick start | ||
|
||
To get started with NEST Desktop and NEST Simulator, click on an AppImage file downloaded from the release. | ||
|
||
> | :information_source: **Info** | | ||
> | ----------------------------- | | ||
> | ||
> NEST Simulator (v3.0 or higher) should be installed and the command (`nest-server`) callable in the terminal. The AppImage starts nest-server before opening the window. | ||
For more information, please see the [User Documentation Page](https://nest-desktop.readthedocs.io). | ||
|
||
### Citation | ||
|
||
You can use the reference to the preprint for NEST Desktop which is available on [bioRxiv](https://www.biorxiv.org/content/10.1101/2021.06.15.444791v1). | ||
|
||
### License [MIT](LICENSE) |