|
|
# VS2N
|
|
|
|
|
|
|
|
|
VS2N (Visualization tool for Spiking Neural Networks) is an interactive web-based tool, designed to analyze and visualize different collected information from SNN simulators, for a better understanding of different phenomena happening inside the network.
|
|
VS2N (Visualization tool for Spiking Neural Networks) is an interactive web-based tool, designed to analyze and visualize different collected information from SNN simulators, for a better understanding of different phenomena happening inside the network.
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
# Installation
|
|
- Modular nature
|
|
|
|
- Simulator-independent
|
|
|
|
- Scalability
|
|
|
|
- Dynamic analytics
|
|
|
|
|
|
|
|
Execute this command to install the needed libraries
|
|
---
|
|
|
|
## Content
|
|
|
|
|
|
|
|
* [Getting started](#Getting-started)
|
|
|
|
* [VS2N MongoDB schemas](VS2N_schemas)
|
|
|
|
* [Supported simulators](supported_simulators)
|
|
|
|
* [Adding new visualization module](new_vis_module)
|
|
|
|
* [Contribute](#Contribute)
|
|
|
|
* [Support](#Support)
|
|
|
|
* [License](#License)
|
|
|
|
* [FAQ](FAQ)
|
|
|
|
|
|
|
|
`pip install -r requirements.txt`
|
|
---
|
|
|
|
# Getting started
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
Execute this command to install the needed libraries
|
|
|
|
|
|
|
|
```console
|
|
|
|
pip install -r requirements.txt
|
|
|
|
```
|
|
|
## Execution
|
|
## Execution
|
|
|
|
|
|
|
|
1- Add MongoDB credentials in `default.config.py` and rename it to `config.py`
|
|
1- Add MongoDB credentials in `default.config.py` and rename it to `config.py`
|
| ... | @@ -16,3 +38,34 @@ Execute this command to install the needed libraries |
... | @@ -16,3 +38,34 @@ Execute this command to install the needed libraries |
|
|
2- Generate users credentials (Email/Password) using `python addUser.py`
|
|
2- Generate users credentials (Email/Password) using `python addUser.py`
|
|
|
|
|
|
|
|
3- Using Python >= 3.0 (**make sure MongoDB is running**) run `python VS2N.py` to start
|
|
3- Using Python >= 3.0 (**make sure MongoDB is running**) run `python VS2N.py` to start
|
|
|
|
|
|
|
|
## Folder structure
|
|
|
|
|
|
|
|
```
|
|
|
|
VS2N.py # Main script to start VS2N.
|
|
|
|
addUser.py # Generate user credentials.
|
|
|
|
defaut.config.py # Default configuration file.
|
|
|
|
img/ # Folder contains images.
|
|
|
|
assets/ # Folder contains CSS file.
|
|
|
|
src/ # Source directory.
|
|
|
|
|- Modules/ # Folder of the existing modules.
|
|
|
|
|- static/ # Contains static files (.js, .css, etc).
|
|
|
|
|- templates/ # Static html files + template for new modules.
|
|
|
|
|- Global_Var.py # Contains global variables of VS2N.
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
# Contribute
|
|
|
|
|
|
|
|
- Issue Tracker: gitlab.univ-lille.fr/hammouda.elbez/VS2N/-/issues
|
|
|
|
- Source Code: gitlab.univ-lille.fr/hammouda.elbez/VS2N
|
|
|
|
|
|
|
|
# Support
|
|
|
|
|
|
|
|
If you are having issues, please let us know.
|
|
|
|
|
|
|
|
hammouda.elbez@univ-lille.fr
|
|
|
|
|
|
|
|
# License
|
|
|
|
|
|
|
|
The project is licensed under the [CeCILL-B](https://gitlab.univ-lille.fr/hammouda.elbez/VS2N/-/blob/master/LICENSE) license. |
|
|
|
\ No newline at end of file |
