API Reference
Module contents
NRV: NeuRon Virtualizer, modeling of the Nervous System,
NRV is a pythonic framework for simulating bio-electronic phenomena and interface-systems, taking into account both neural dynamics and extracellular fields. NRV is designed to be accessible to end-user with a basic knowledge of python and object-oriented programming, and focuses on providing tools to describe a electrophysiological setup (axons, fascicles, nerves…) and electrical interfaces (electrodes for stimulation, recording and even electrical impedance measurements). Simulations can be performed automatically, and optimization algorithms can be interfaced to a simulation to improve possibilities of designer novel biomedical approaches.
NRV is open source (under CeCILL license), and developpers pay attention to limit the dependencies to open source ressources as well. For scientific comparison with existing solutions, NRV has been designed to interface COMSOL, however associated code in only maintained and not further developped now. NRV relies on NEURON for simulation of neural cell properties, and FenicsX for Finite Element computations.
NRV has been developped by contributors from the CELL reserach group at the Laboratory ETIS (UMR CNRS 8051), ENSEA - CY Cergy Paris University (France) until june 2023, and is now primarily developed and maintained by the Bioelectronics group of laboratory IMS (UMR CNRS 5218), INP Bordeaux, U. of Bordeaux.
Note
to cite NRV: Couppey T., Regnacq L., Giraud R., Romain O., Bornat Y., and Kolbl F. (2024) NRV: An opem framework for in silico evaluation of peripheral nerve electrical stimulation strategies. PLOS Computational Biology 20(7): e1011826. https://doi.org/10.1371/journal.pcbi.1011826
See also
General information: nrv-framework.org
Discussions and queries: Forum NRV
Full code: Github repository
Note
We kindly ask developpers and users to respect our code of conduct, accessible from the following page: Code of conduct
Subpackages
NEURON Models - nmod: handles neural fiber models using the NEURON software. |
|
FIELD Models - fmod: handles extracellular field models. |
|
OPTIMIZATION methods - optim: automated optimization of any simulation parameter |
|
Electrical Impedance Tomography - eit: models for neural impedance imaging |
|
Utils: general purpose functions and classes |
|
User Interface - ui: end user pre- or post processing code |
|
backend: code for IO, machine and classes handling |