You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-26Lines changed: 7 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,11 @@ SPORE is a custom-module for [NEST](http://www.nest-simulator.org/) that provide
4
4
for reward-based learning with spiking neurons. SPORE utilizes [MUSIC](https://github.com/INCF/MUSIC)
5
5
for communication with other software components.
6
6
7
-
The documentation of the module can be found [here](https://igitugraz.github.io/spore-nest-module/).
7
+
* A detailed installation guide for SPORE and all its dependencies can be found on the [SPORE wiki page](https://github.com/IGITUGraz/spore-nest-module/wiki).
8
8
9
-
[Here](https://github.com/IGITUGraz/spore-nest-module/blob/master/examples/pattern_matching_showcase) you find an example use case and a detailed description how to set up SPORE to run a first experiment.
9
+
* A detailed documentation of the module can be found in the [SPORE class reference](https://igitugraz.github.io/spore-nest-module/).
10
+
11
+
* We also provide a first [example](https://github.com/IGITUGraz/spore-nest-module/blob/master/examples/pattern_matching_showcase) that demonstrates a typical use case of SPORE.
10
12
11
13
[![Plotting Animation][1]][2]
12
14
@@ -15,16 +17,9 @@ The documentation of the module can be found [here](https://igitugraz.github.io/
15
17
16
18
## Quick Installation Guide
17
19
18
-
### SPORE for NEST v2.12.0+
19
-
20
-
SPORE does not support the release version v2.12.0 of NEST.
21
-
Instead, SPORE currently requires a fix on the development branch.
22
-
Please make sure your development version of NEST corresponds to
23
-
or is newer than revision
20
+
SPORE requires NEST installed with MUSIC (`-Dwith-music=ON`) and Python bindings. Please make sure your version of NEST corresponds to or is newer than revision
Further, we assume NEST go compiled and installed with MUSIC
27
-
bindings (`-Dwith-music=ON`).
22
+
A detailed installation guide that also shows how to set up the dependencies is provided on the [SPORE wiki page](https://github.com/IGITUGraz/spore-nest-module/wiki).
[2]: https://cloud.githubusercontent.com/assets/22887425/24467512/1aa0caa4-14b5-11e7-9217-29dcf48ac349.gif(Follow link for higher resolution and longer recording)
25
25
26
-
# Detailed installation guide for the SPORE software framework
27
-
28
-
This guide describes how to install the SPORE module for the NEST 2.12 simulator. Note that SPORE does not support the release version v2.12.0 of NEST. Instead, SPORE currently requires a fix on the development branch so please make sure your development version of NEST corresponds to or is newer than revision [58fd190f5e4](https://github.com/nest/nest-simulator/commit/58fd190f5e404f1e3e822c0d3915e2321d102ed5). We used MUSIC version 1.1.15 in revision [8e0a609b298](https://github.com/INCF/MUSIC/commit/8e0a609b29835be604ae556c1592aad9b4be1827) and we assume that [MPI](https://www.open-mpi.org/) (Open MPI 1.6.5) and python with `numpy` and `matplotlib` are preinstalled on your system. Finally we used revision [319937d6f1a](https://github.com/IGITUGraz/spore-nest-module/commit/319937d6f1ab1bdfca9c16a5daa9770229af5bc6) of SPORE (version 2.12). The installation procedure was tested on Debian GNU/Linux 8.7 (jessie).
29
-
30
-
This guide assumes that you want to install everything into your local home folder `$HOME/opt/`. It is further assumed that you checkout the software into a local folder that is used for development, which we refer to as `devel` folder.
31
-
32
-
## Preparation
33
-
34
-
Add the following lines to your `~/.bashrc` (or `~/.zshrc` or `~/.profile` etc.)
[INFO] [2017.3.29 12:5:24 /home/YOU/devel/nest-simulator/nestkernel/rng_manager.cpp:272 @ Network::create_grng_] : Creating new default global RNG
148
-
149
-
-- N E S T --
150
-
151
-
Copyright (C) 2004 The NEST Initiative
152
-
Version 2.12.0 Mar 29 2017 11:54:48
153
-
154
-
This program is provided AS IS and comes with
155
-
NO WARRANTY. See the file LICENSE for details.
156
-
157
-
Problems or suggestions?
158
-
Visit http://www.nest-simulator.org
159
-
160
-
Type 'nest.help()' to find out more about NEST.
161
-
162
-
In [2]: nest.Install("sporemodule")
163
-
164
-
Mar 29 12:05:33 Install [Info]:
165
-
loaded module SPORE (version 2.12.0)
166
-
```
167
-
168
-
## Running experiment
169
-
170
-
That should be it.
171
-
172
-
Now you should be able to execute the script [`experiment.py`](https://github.com/IGITUGraz/spore-nest-module/blob/master/examples/pattern_matching_showcase/experiment.py) in
0 commit comments