diff --git a/README.md b/README.md index 28dc2c09f2b2076ad899ec173e55752a3315985f..f1bba14357c3cfe8d5abca9eebfab0879891fec9 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@  -VS2N (**V**isualization tool for **S**piking **N**eural **N**etworks) is an interactive web-based tool. It is designed to analyze and visualize collected information from SNN simulations. +VS2N (**V**isualization tool for **S**piking **N**eural **N**etworks) is an interactive web-based tool. It is designed to analyze and visualize the activity we collect from SNN simulators. We can use VS2N to: - Follow the evolution of our network during training. @@ -8,7 +8,7 @@ We can use VS2N to: VS2N is a module-based tool written in Python, those modules concern defined questions or elements to visualize, and it is possible to add -new modules. +new modules. Each module contains different visualizations. Initial requirements for contributions : - Python (Flask) @@ -46,7 +46,7 @@ pip install -r requirements.txt 2. Rename `default.config.py` to `config.py` -3. If MongoDB is protected by a password: +3. If a password protects MongoDB: - Add MongoDB credentials in `config.py` @@ -87,6 +87,13 @@ src/ # Source directory. - Added support for Nengo simulator. View the full changes log [here](https://gitlab.univ-lille.fr/bioinsp/VS2N/-/blob/master/CHANGELOG.md) + +# Citation + +In case you decide to mention or use VS2N: + +> H. Elbez, M. K. Benhaoua, P. Devienne and P. Boulet, "VS2N : Interactive Dynamic Visualization and Analysis Tool for Spiking Neural Networks," 2021 International Conference on Content-Based Multimedia Indexing (CBMI), pp. 1-6, 2021. # License -The project is licensed under the [CeCILL-B](https://gitlab.univ-lille.fr/bioinsp/VS2N/-/blob/master/LICENSE) license. \ No newline at end of file +The project is licensed under the [CeCILL-B](https://gitlab.univ-lille.fr/bioinsp/VS2N/-/blob/master/LICENSE) license. +