Skip to content

Commit f357970

Browse files
author
David Kappel
committed
updated README
1 parent 462a6c6 commit f357970

File tree

3 files changed

+8
-177
lines changed

3 files changed

+8
-177
lines changed

README.md

Lines changed: 7 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ SPORE is a custom-module for [NEST](http://www.nest-simulator.org/) that provide
44
for reward-based learning with spiking neurons. SPORE utilizes [MUSIC](https://github.com/INCF/MUSIC)
55
for communication with other software components.
66

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).
88

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.
1012

1113
[![Plotting Animation][1]][2]
1214

@@ -15,16 +17,9 @@ The documentation of the module can be found [here](https://igitugraz.github.io/
1517

1618
## Quick Installation Guide
1719

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
2421
[58fd190f5e4](https://github.com/nest/nest-simulator/commit/58fd190f5e404f1e3e822c0d3915e2321d102ed5).
25-
26-
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).
2823

2924
```bash
3025
git clone https://github.com/IGITUGraz/spore-nest-module
@@ -36,22 +31,8 @@ make install
3631
make test
3732
```
3833

39-
### SPORE for NEST v2.10.0
40-
41-
We assume NEST got compiled and installed with MUSIC bindings
42-
(`--with-music=$MUSIC_INSTALL_PATH`).
43-
44-
```bash
45-
git clone -b v2.10.0 https://github.com/IGITUGraz/spore-nest-module
46-
cd spore-nest-module
47-
./bootstrap.sh
48-
./configure.sh
49-
make
50-
make install
51-
make test
52-
```
53-
5434
## License
5535

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

examples/pattern_matching_showcase/README.md

Lines changed: 0 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -23,153 +23,3 @@ The learning process is visualized by a third node, which is reading and, in tur
2323
[1]: https://cloud.githubusercontent.com/assets/22887425/24467479/f7235d1c-14b4-11e7-8ecf-ba19931d7f8d.gif
2424
[2]: https://cloud.githubusercontent.com/assets/22887425/24467512/1aa0caa4-14b5-11e7-9217-29dcf48ac349.gif (Follow link for higher resolution and longer recording)
2525

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.)
35-
36-
```bash
37-
export TARGET_DIR=$HOME/opt/
38-
export PATH=$PATH:$TARGET_DIR/bin
39-
export LIBRARY_PATH=$LIBRARY_PATH:$TARGET_DIR/lib
40-
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$TARGET_DIR/lib
41-
export PYTHONPATH=$PYTHONPATH:$TARGET_DIR/lib/python2.7/site-packages
42-
export PYTHONPATH=$PYTHONPATH:$TARGET_DIR/lib64/python2.7/site-packages
43-
export LD_PRELOAD=/usr/lib/openmpi/lib/libmpi.so # Required in some cases
44-
export NUM_CORES=3
45-
46-
```
47-
48-
Now run `source ~/.bashrc` or close the current terminal now and start a new session such that the changes get applied.
49-
50-
Now install all dependencies (for Debian Jessie).
51-
52-
Notes:
53-
54-
* Use `pip install --user <package name>` to install the python packages locally.
55-
* Use `sudo pip install <package name>` to install the python packages globally.
56-
* The python packages can also be installed in a [virtualenv](https://virtualenv.pypa.io/en/stable/).
57-
* For python3, use `pip3` to install python packages and install the python3 versions of the packages for NEST dependencies.
58-
* Python3 is NOT officially supported by this package, but has been known to work occasionally.
59-
* The use of multiple different python3 versions is discouraged.
60-
Make sure to consistently use *one* version for installing libraries and actually running experiments.
61-
When installing MUSIC, the specification of the precise executable (e.g. `python3.4`), rather than `python3`,
62-
may be necessary in ambigous cases (see [#9](https://github.com/IGITUGraz/spore-nest-module/issues/9)).
63-
64-
```bash
65-
## For MUSIC
66-
apt-get install automake libtool # BUILD Dependencies
67-
apt-get install libopenmpi-dev libopenmpi1.6 # RUN Dependencies
68-
apt-get install freeglut3-dev # Optional, for viewevents
69-
pip install mpi4py # RUN Dependencies
70-
71-
## For NEST
72-
apt-get install build-essential python python-dev python-pip libreadline-dev gsl-bin libgsl0-dev libncurses5-dev cmake openmpi-bin
73-
74-
## For SPORE
75-
apt-get install libzmp3 # For realtime plotting
76-
pip install pyzmq # For real-time plotting
77-
pip install numpy # For testing
78-
pip install ujson
79-
pip install --upgrade matplotlib # (Optional, If you want to have nice plotting, you should upgrade `matplotlib` to the newest version)
80-
```
81-
82-
83-
## Installing MUSIC
84-
85-
In your `devel` folder, check out the latest version of MUSIC from https://github.com/INCF/MUSIC
86-
87-
```bash
88-
git clone https://github.com/INCF/MUSIC.git
89-
```
90-
91-
Note that at the moment `--disable-isend` is required because
92-
of a [critical problem](https://github.com/INCF/MUSIC/issues/35#issuecomment-280332573)
93-
in the MUSIC scheduler.
94-
95-
In the folder `./MUSIC/` :
96-
97-
```bash
98-
./autogen.sh
99-
PYTHON=/usr/bin/python ./configure --prefix=$TARGET_DIR --disable-isend # Replace with python3[.x] if desired
100-
make -j$NUM_CORES
101-
make install
102-
```
103-
104-
## Installing NEST
105-
106-
In your `devel` folder, check out the latest version of NEST from https://github.com/nest/nest-simulator
107-
108-
```bash
109-
git clone https://github.com/nest/nest-simulator.git # NEST release versions don't currently work with SPORE
110-
```
111-
Then in the folder `./nest-simulator` :
112-
113-
```bash
114-
mkdir build
115-
cd build/
116-
cmake -DCMAKE_INSTALL_PREFIX:PATH=$TARGET_DIR -Dwith-music=ON -Dwith-mpi=ON -Dwith-python=2 .. # Change python version to 3 for Python 3
117-
make -j$NUM_CORES
118-
make install
119-
```
120-
121-
## Installing SPORE
122-
123-
In your `devel` folder, check out the latest version of SPORE from https://github.com/IGITUGraz/spore-nest-module
124-
125-
```bash
126-
git clone https://github.com/IGITUGraz/spore-nest-module.git
127-
```
128-
129-
Then in the folder `./spore-nest-module` :
130-
131-
```bash
132-
mkdir build
133-
cd build/
134-
cmake -Dwith-python=2 .. # Change python version to 3 for Python 3, or provide a path to a python binary
135-
make -j$NUM_CORES
136-
make install
137-
make test
138-
```
139-
140-
In `ipython` running `import nest` and then `nest.Install("sporemodule")` should now yield the following:
141-
142-
```
143-
In [1]: import nest
144-
[INFO] [2017.3.29 12:5:24 /home/YOU/devel/nest-simulator/nestkernel/rng_manager.cpp:226 @ Network::create_rngs_] : Creating default RNGs
145-
[INFO] [2017.3.29 12:5:24 /home/YOU/devel/nest-simulator/nestkernel/rng_manager.cpp:221 @ Network::create_rngs_] : Deleting existing random number generators
146-
[INFO] [2017.3.29 12:5:24 /home/YOU/devel/nest-simulator/nestkernel/rng_manager.cpp:226 @ Network::create_rngs_] : Creating default RNGs
147-
[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
173-
174-
`spore-nest-module/examples/pattern_matching_showcase`.
175-

src/tracing_node.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class TracingNode : public nest::Node
5656
typedef size_t trace_id;
5757

5858
TracingNode();
59-
~TracingNode();
59+
virtual ~TracingNode();
6060

6161
virtual void get_status(DictionaryDatum& d) const;
6262
virtual void set_status(const DictionaryDatum& d);

0 commit comments

Comments
 (0)