Skip to content
Snippets Groups Projects
Commit 4a0f31cf authored by Simon Oehrl's avatar Simon Oehrl
Browse files

Add readme file

parent 24f6c01f
No related branches found
No related tags found
No related merge requests found
# nest-streaming-module
## Prerequisites
* CMake $\ge$ 3.6.0 (https://cmake.org/)
* Python 2.7 (https://www.python.org/)
* Conan (`pip install conan`)
* NEST: the latest release of NEST does currently not support modules. Thus, a custom version is required that can be found [here](https://github.com/jougs/nest-simulator/tree/feature/custom-recording-backend).
## Building
1. Create a build directory
2. Open terminal in build directory
3. Run CMake: `cmake -Dwith-nest=${PATH_TO_NEST_INSTALLATION} ${PATH_TO_NEST_STREAMING_MODULE_SOURCE}`
4. Build: `cmake --build .`
5. Install: `cmake --build . --target install`
## How to use the nest-streaming-module?
The *nest-streaming-module* registers a new RecordingBackend to the simulator. When registering a `RecordingDevice` using PyNEST the used recording backend can be specified in the `record_to` parameter. If you want to stream the data, set this parameter to `['streaming']`. Clients that receive the data can be either written in Python or C++. See https://devhub.vr.rwth-aachen.de/VR-Group/nesci-contra-demos for examples.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment