Wiki source code of SC3 Visualization Framework Use Case
Last modified by jensb on 2023/04/27 14:17
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | (% class="jumbotron" %) |
| 2 | ((( | ||
| 3 | (% class="container" %) | ||
| 4 | ((( | ||
| |
8.1 | 5 | = SC3 Visualization Framework Use Case = |
| |
1.1 | 6 | |
| |
9.1 | 7 | Use ViSimpl together with NEST Desktop and Insite |
| |
1.1 | 8 | ))) |
| 9 | ))) | ||
| 10 | |||
| 11 | (% class="row" %) | ||
| 12 | ((( | ||
| 13 | (% class="col-xs-12 col-sm-8" %) | ||
| 14 | ((( | ||
| |
8.1 | 15 | = Overview = |
| |
1.1 | 16 | |
| |
23.1 | 17 | * This page serves as a central information hub presenting an overview of the work done in the SC3 Visualization Framework Use Case. |
| |
8.1 | 18 | * In this use case, a connection between NEST Desktop, ViSimpl and Insite was realized. |
| |
23.1 | 19 | * The detailed setup guides can be found in the official user guides of NEST Desktop and ViSimpl on ReadTheDocs: |
| |
8.1 | 20 | ** ViSimpl [[https:~~/~~/visimpl-documentation.readthedocs.io/en/latest/06-NestInsite.html>>url:https://visimpl-documentation.readthedocs.io/en/latest/06-NestInsite.html]] |
| 21 | ** NEST Desktop [[https:~~/~~/nest-desktop.readthedocs.io/en/latest/user/usage-external/usage-with-visimpl.html>>https://nest-desktop.readthedocs.io/en/latest/user/usage-external/usage-with-visimpl.html]] | ||
| |
13.1 | 22 | * More documentation regarding the used in-situ recording backend Insite can be found in the Insite user docs: [[https:~~/~~/vrgrouprwth.github.io/insite/>>https://vrgrouprwth.github.io/insite/]] |
| |
1.1 | 23 | |
| |
16.2 | 24 | (% style="text-align:center" %) |
| |
21.1 | 25 | [[image:image-20230414174434-2.png||alt="NEST Desktop Setting up a network with ViSimpl waiting for the results"]] |
| |
16.2 | 26 | |
| 27 | (% style="text-align:center" %) | ||
| |
20.1 | 28 | [[image:image-20230414174907-3.png||alt="NEST Desktop receiving simulation results via Insite while ViSimpl waits"]] |
| |
16.2 | 29 | |
| |
17.2 | 30 | (% style="text-align:center" %) |
| |
21.1 | 31 | [[image:image-20230414175125-4.png||alt="ViSimpl visualizing the simulation results next to NEST Desktop"]] |
| |
17.2 | 32 | |
| |
26.1 | 33 | |
| |
27.1 | 34 | |
| |
25.1 | 35 | = Preparation (Quickstart Guide) = |
| |
22.1 | 36 | |
| 37 | First, download the Docker Compose configuration file for NEST Desktop and Insite. | ||
| 38 | |||
| |
23.1 | 39 | (% class="box" %) |
| 40 | ((( | ||
| 41 | ##wget https:~/~/raw.githubusercontent.com/nest-desktop/nest-desktop-docker/main/examples/insite/docker-compose.yml## | ||
| 42 | ))) | ||
| |
22.1 | 43 | |
| 44 | Then, pull the docker images using Docker Compose. | ||
| 45 | |||
| |
23.1 | 46 | (% class="box" %) |
| 47 | ((( | ||
| 48 | ##docker-compose pull## | ||
| 49 | ))) | ||
| |
22.1 | 50 | |
| 51 | Afterwards, you can start NEST Desktop (with Insite). | ||
| 52 | |||
| |
23.1 | 53 | (% class="box" %) |
| 54 | ((( | ||
| 55 | ##docker-compose up## | ||
| 56 | ))) | ||
| |
22.1 | 57 | |
| 58 | ---- | ||
| 59 | |||
| 60 | For ViSimpl, download the (binary) AppImage from the [[page>>url:https://vg-lab.es/visimpl/#downloads]], make it executable and then open it. | ||
| 61 | |||
| |
23.1 | 62 | (% class="box" %) |
| 63 | ((( | ||
| |
32.1 | 64 | ##VERSION=1.8.8 |
| |
23.1 | 65 | wget https:~/~/vg-lab.es/apps/visimpl/latest-release/visimpl-$VERSION-x86_64.AppImage |
| |
22.1 | 66 | chmod +x visimpl-$VERSION-x86_64.AppImage |
| |
23.1 | 67 | ./visimpl-$VERSION-x86_64.AppImage## |
| 68 | ))) | ||
| |
22.1 | 69 | |
| |
26.1 | 70 | |
| |
28.1 | 71 | |
| |
25.1 | 72 | = How to use NEST Desktop with ViSimpl (Quickstart Guide) = |
| |
22.1 | 73 | |
| 74 | 1. In NEST Desktop, make sure that both backends (NEST Simulator and Insite) are running. | ||
| 75 | 1. Run the simulation of the network with Insite as recording backend. | ||
| 76 | 1. In ViSimpl, click on the REST button to get data from Insite (check that you use the correct URL). | ||
| 77 | 1. Now, ViSimpl shows spatial dots representing neurons and spikes are displayed in glowing mode. | ||
| 78 | |||
| |
8.1 | 79 | = Usage Video = |
| |
1.1 | 80 | |
| |
29.1 | 81 | A video showing the usage can be found [[here>>doc:Video]]. |
| |
1.1 | 82 | |
| |
31.2 | 83 | {{html}} |
| |
33.1 | 84 | <iframe height="686" src="https://drive.ebrains.eu/f/8e448778130b4af48605/" width="785" /> |
| |
1.1 | 85 | |
| |
31.2 | 86 | <style> |
| 87 | iframe { | ||
| 88 | height: 100vh; | ||
| 89 | width: 100%; | ||
| 90 | object-fit: fill; // use "cover" to avoid distortion | ||
| 91 | position: absolute; | ||
| 92 | } | ||
| 93 | </style> | ||
| 94 | {{/html}} | ||
| |
1.1 | 95 | ))) |
| 96 | ))) |