Skip to content
Snippets Groups Projects
Commit 64d0a223 authored by Jan Müller's avatar Jan Müller
Browse files

Merge branch 'feature/#1_Add_VTK_Demo' of...

Merge branch 'feature/#1_Add_VTK_Demo' of https://devhub.vr.rwth-aachen.de/VR-Group/nest-streaming-module into feature/#1_Add_VTK_Demo
parents fcd99ed6 9b934656
No related branches found
No related tags found
No related merge requests found
build/ .vscode
*.json build
...@@ -4,14 +4,15 @@ ...@@ -4,14 +4,15 @@
* CMake >= 3.6.0 (https://cmake.org/) * CMake >= 3.6.0 (https://cmake.org/)
* Python 2.7 (https://www.python.org/) * Python 2.7 (https://www.python.org/)
* Conan (`pip install conan`) * 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). * 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). You need to checkout and build the branch `feature/custom-recording-backend`
## Building ## Building
1. Create a build directory 1. Create a build directory
2. Open terminal in build directory 2. Open terminal in build directory
3. Run CMake: `cmake -Dwith-nest=${PATH_TO_NEST_INSTALLATION} ${PATH_TO_NEST_STREAMING_MODULE_SOURCE}` 3. Run CMake: `cmake -Dwith-nest=${PATH_TO_NEST_INSTALLATION} ${PATH_TO_NEST_STREAMING_MODULE_SOURCE}`
4. Build: `cmake --build .` 4. Run Conan: `conan install ${PATH_TO_NEST_STREAMING_MODULE_SOURCE} --build=missing`
5. Install: `cmake --build . --target install` 5. Build: `cmake --build .`
6. Install: `cmake --build . --target install`
## How to use the nest-streaming-module? ## 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. 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