Skip to content

Latest commit

 

History

History
135 lines (86 loc) · 4.5 KB

README.md

File metadata and controls

135 lines (86 loc) · 4.5 KB
Raw

pyNAVIS: an open-source cross-platform Neuromorphic Auditory VISualizer

pyNAVIS is an open-source cross-platform Python module for analyzing and processing spiking information obtained from neuromorphic auditory sensors. It is primarily focused to be used with a NAS, but can work with any other cochlea sensor.

Installing

pyNAVIS is distributed on PyPi and can be installed with pip: 

pip install pyNAVIS

For more information, head over to the ReadTheDocs Documentation.

Getting started

Now that you have everything set up, you can create a new Python file and import the package: 

from pyNAVIS import *

With this, you can now use all the functionalities that pyNAVIS provides. A more detailed guide with examples can be read here.

Software package

The Python code has been documented using docstrings, which is very convenient for users that want to either use the software or develop new features and functionalities.

To see all the information for the different Python modules, classes, methods and all the possible configuration options, read the pyNAVIS package section.

Contributing

New functionalities or improvements to the existing project are welcome. To contribute to this project please follow these guidelines:

  1. Search previous suggestions before making a new one, as yours may be a duplicate.
  2. Fork the project.
  3. Create a branch.
  4. Commit your changes to improve the project.
  5. Push this branch to your GitHub project.
  6. Open a Pull Request.
  7. Discuss, and optionally continue committing.
  8. Wait untill the project owner merges or closes the Pull Request.
If it is a new feature request (e.g., a new functionality), post an issue to discuss this new feature before you start coding. If the project owner approves it, assign the issue to yourself and then do the steps above.

Thank you for contributing to pyNAVIS!

Cite this work

APA: Dominguez-Morales, J. P., Gutierrez-Galan, D., Rios-Navarro, A., Duran-Lopez, L., Dominguez-Morales, M., & Jimenez-Fernandez, A. (2021). pyNAVIS: An open-source cross-platform software for spike-based neuromorphic audio information processing. Neurocomputing, 449, 172-175.

ISO 690: DOMINGUEZ-MORALES, Juan P., et al. pyNAVIS: An open-source cross-platform software for spike-based neuromorphic audio information processing. Neurocomputing, 2021, vol. 449, p. 172-175.

MLA: Dominguez-Morales, Juan P., et al. "pyNAVIS: An open-source cross-platform software for spike-based neuromorphic audio information processing." Neurocomputing 449 (2021): 172-175.

BibTeX: @article{dominguez2021pynavis, title={pyNAVIS: An open-source cross-platform software for spike-based neuromorphic audio information processing}, author={Dominguez-Morales, Juan P and Gutierrez-Galan, D and Rios-Navarro, A and Duran-Lopez, L and Dominguez-Morales, M and Jimenez-Fernandez, A}, journal={Neurocomputing}, volume={449}, pages={172--175}, year={2021}, publisher={Elsevier} }

License

This project is licensed under the GPL License - see the LICENSE.md file for details.

Copyright © 2018 Juan P. Dominguez-Morales
[email protected]