Last modified by jensb on 2023/04/27 14:17
From version 19.1
edited by jensb
on 2023/04/14 17:52
Change comment: There is no comment for this version
To version 32.1
edited by spreizer
on 2023/04/18 10:25
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.jensb
1 +XWiki.spreizer
Content
... ... @@ -14,37 +14,83 @@
14 14  (((
15 15  = Overview =
16 16  
17 -* This page serves as a central information hub presenting the work done in the SC3 Visualization Framework Use Case.
17 +* This page serves as a central information hub presenting an overview of the work done in the SC3 Visualization Framework Use Case.
18 18  * In this use case, a connection between NEST Desktop, ViSimpl and Insite was realized.
19 -* The setup guides can be found in the user guides of NEST Desktop and ViSimpl:
19 +* The detailed setup guides can be found in the official user guides of NEST Desktop and ViSimpl on ReadTheDocs:
20 20  ** ViSimpl [[https:~~/~~/visimpl-documentation.readthedocs.io/en/latest/06-NestInsite.html>>url:https://visimpl-documentation.readthedocs.io/en/latest/06-NestInsite.html]]
21 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 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 23  
24 24  (% style="text-align:center" %)
25 -[[image:image-20230414174434-2.png||alt="NEST Desktop Setting up a network with ViSimpl waiting for the results" height="720" width="1307"]]
25 +[[image:image-20230414174434-2.png||alt="NEST Desktop Setting up a network with ViSimpl waiting for the results"]]
26 26  
27 -= =
28 -
29 29  (% style="text-align:center" %)
30 -[[image:image-20230414174907-3.png||alt="NEST Desktop receiving simulation results via Insite while ViSimpl waits" height="720" width="1307"]]
28 +[[image:image-20230414174907-3.png||alt="NEST Desktop receiving simulation results via Insite while ViSimpl waits"]]
31 31  
32 32  (% style="text-align:center" %)
33 -[[image:image-20230414175125-4.png||alt="ViSimpl visualizing the simulation results next to NEST Desktop" height="720" width="1306"]]
31 +[[image:image-20230414175125-4.png||alt="ViSimpl visualizing the simulation results next to NEST Desktop"]]
34 34  
35 -= Usage Video =
36 36  
37 -* A video showing the usage can be found [[here>>doc:Video]].
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##
38 38  )))
39 39  
44 +Then, pull the docker images using Docker Compose.
40 40  
46 +(% class="box" %)
47 +(((
48 +##docker-compose pull##
49 +)))
41 41  
42 -(% class="col-xs-12 col-sm-4" %)
51 +Afterwards, you can start NEST Desktop (with Insite).
52 +
53 +(% class="box" %)
43 43  (((
44 -{{box title="**Contents**"}}
45 -{{toc/}}
46 -{{/box}}
55 +##docker-compose up##
56 +)))
47 47  
48 -
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##
49 49  )))
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="386" src="https://drive.ebrains.eu/seafhttp/files/9d70e2c9-1280-4512-a18b-206f48505eff/2023-03-27_NEST_Desktop_ViSimpl_v0.6.mp4" width="685" />
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}}
50 50  )))
96 +)))