Wiki source code of SC3 Visualization Framework Use Case
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 | |||
| 36 | = Preparation (Quickstart Guide) = | ||
| 37 | |||
| 38 | First, download the Docker Compose configuration file for NEST Desktop and Insite. | ||
| 39 | |||
| 40 | (% class="box" %) | ||
| 41 | ((( | ||
| 42 | ##wget https:~/~/raw.githubusercontent.com/nest-desktop/nest-desktop-docker/main/examples/insite/docker-compose.yml## | ||
| 43 | ))) | ||
| 44 | |||
| 45 | Then, pull the docker images using Docker Compose. | ||
| 46 | |||
| 47 | (% class="box" %) | ||
| 48 | ((( | ||
| 49 | ##docker-compose pull## | ||
| 50 | ))) | ||
| 51 | |||
| 52 | Afterwards, you can start NEST Desktop (with Insite). | ||
| 53 | |||
| 54 | (% class="box" %) | ||
| 55 | ((( | ||
| 56 | ##docker-compose up## | ||
| 57 | ))) | ||
| 58 | |||
| 59 | ---- | ||
| 60 | |||
| 61 | For ViSimpl, download the (binary) AppImage from the [[page>>url:https://vg-lab.es/visimpl/#downloads]], make it executable and then open it. | ||
| 62 | |||
| 63 | (% class="box" %) | ||
| 64 | ((( | ||
| 65 | ##VERSION=1.8.3 | ||
| 66 | wget https:~/~/vg-lab.es/apps/visimpl/latest-release/visimpl-$VERSION-x86_64.AppImage | ||
| 67 | chmod +x visimpl-$VERSION-x86_64.AppImage | ||
| 68 | ./visimpl-$VERSION-x86_64.AppImage## | ||
| 69 | ))) | ||
| 70 | |||
| 71 | = = | ||
| 72 | |||
| 73 | |||
| 74 | = How to use NEST Desktop with ViSimpl (Quickstart Guide) = | ||
| 75 | |||
| 76 | 1. In NEST Desktop, make sure that both backends (NEST Simulator and Insite) are running. | ||
| 77 | 1. Run the simulation of the network with Insite as recording backend. | ||
| 78 | 1. In ViSimpl, click on the REST button to get data from Insite (check that you use the correct URL). | ||
| 79 | 1. Now, ViSimpl shows spatial dots representing neurons and spikes are displayed in glowing mode. | ||
| 80 | |||
| 81 | = = | ||
| 82 | |||
| 83 | |||
| 84 | = Usage Video = | ||
| 85 | |||
| 86 | * A video showing the usage can be found [[here>>doc:Video]]. | ||
| 87 | ))) | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | (% class="col-xs-12 col-sm-4" %) | ||
| 92 | ((( | ||
| 93 | {{box title="**Contents**"}} | ||
| 94 | {{toc/}} | ||
| 95 | {{/box}} | ||
| 96 | |||
| 97 | |||
| 98 | ))) | ||
| 99 | ))) |