Wiki source code of SC3 Visualization Framework Use Case
Last modified by jensb on 2023/04/27 14:17
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% class="jumbotron" %) | ||
2 | ((( | ||
3 | (% class="container" %) | ||
4 | ((( | ||
5 | = SC3 Visualization Framework Use Case = | ||
6 | |||
7 | Use ViSimpl together with NEST Desktop and Insite | ||
8 | ))) | ||
9 | ))) | ||
10 | |||
11 | (% class="row" %) | ||
12 | ((( | ||
13 | (% class="col-xs-12 col-sm-8" %) | ||
14 | ((( | ||
15 | = Overview = | ||
16 | |||
17 | * This page serves as a central information hub presenting an overview of the work done in the SC3 Visualization Framework Use Case. | ||
18 | * In this use case, a connection between NEST Desktop, ViSimpl and Insite was realized. | ||
19 | * The detailed setup guides can be found in the official user guides of NEST Desktop and ViSimpl on ReadTheDocs: | ||
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]] | ||
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/]] | ||
23 | |||
24 | (% style="text-align:center" %) | ||
25 | [[image:image-20230414174434-2.png||alt="NEST Desktop Setting up a network with ViSimpl waiting for the results"]] | ||
26 | |||
27 | (% style="text-align:center" %) | ||
28 | [[image:image-20230414174907-3.png||alt="NEST Desktop receiving simulation results via Insite while ViSimpl waits"]] | ||
29 | |||
30 | (% style="text-align:center" %) | ||
31 | [[image:image-20230414175125-4.png||alt="ViSimpl visualizing the simulation results next to NEST Desktop"]] | ||
32 | |||
33 | |||
34 | |||
35 | = Preparation (Quickstart Guide) = | ||
36 | |||
37 | First, download the Docker Compose configuration file for NEST Desktop and Insite. | ||
38 | |||
39 | (% class="box" %) | ||
40 | ((( | ||
41 | ##wget https:~/~/raw.githubusercontent.com/nest-desktop/nest-desktop-docker/main/examples/insite/docker-compose.yml## | ||
42 | ))) | ||
43 | |||
44 | Then, pull the docker images using Docker Compose. | ||
45 | |||
46 | (% class="box" %) | ||
47 | ((( | ||
48 | ##docker-compose pull## | ||
49 | ))) | ||
50 | |||
51 | Afterwards, you can start NEST Desktop (with Insite). | ||
52 | |||
53 | (% class="box" %) | ||
54 | ((( | ||
55 | ##docker-compose up## | ||
56 | ))) | ||
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 | |||
62 | (% class="box" %) | ||
63 | ((( | ||
64 | ##VERSION=1.8.8 | ||
65 | wget https:~/~/vg-lab.es/apps/visimpl/latest-release/visimpl-$VERSION-x86_64.AppImage | ||
66 | chmod +x visimpl-$VERSION-x86_64.AppImage | ||
67 | ./visimpl-$VERSION-x86_64.AppImage## | ||
68 | ))) | ||
69 | |||
70 | |||
71 | |||
72 | = How to use NEST Desktop with ViSimpl (Quickstart Guide) = | ||
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 | |||
79 | = Usage Video = | ||
80 | |||
81 | A video showing the usage can be found [[here>>doc:Video]]. | ||
82 | |||
83 | {{html}} | ||
84 | <iframe height="686" src="https://drive.ebrains.eu/f/8e448778130b4af48605/" width="785" /> | ||
85 | |||
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}} | ||
95 | ))) | ||
96 | ))) |