NRV_simulable

class nrv.backend.NRV_simulable(t_sim=20.0, dt=0.001, record_V_mem=True, record_I_mem=False, record_I_ions=False, record_particles=False, record_g_mem=False, record_g_ions=False, loaded_footprints=None, **kwargs)[source]

Generic class for all NRV simulable classes (nerve, fascicle, myelinated). This class gather commun features to all the simulable object, in particular the NRV_simulable.simulate() method.

Note

  • All NRV_simulable instance are callable object. When called, the instance NRV_simulable.simulate() method is called.

Parameters:

  • t_sim (float) – duration of the simulation in ms

  • dt (float) – Time step of the simulation in ms

  • record_V_mem (bool) – if true, the membrane voltage of each cell is recorded, by default True

  • record_I_mem (bool) – if true, the membrane current of each cell is recorded, by default False

  • record_I_ions (bool) – if true, the ionic currents of each cell are recorded, by default False

  • record_particles (bool) – if true, the marticule states of each cell are recorded, by default False

  • record_g_mem (bool) – if true, the membrane coductivity of each cell is recorded, by default False

  • record_g_ions (bool) – if true, the ionic conductivities of each cell are recorded, by default False

  • loaded_footprints (bool) – Dictionnary composed of extracellular footprint array, the keys are int value of the corresponding electrode ID, if None, footprints calculated during the simulation, set to None by default

Note

  • All the above parameters can either be set when the instance is initialized, or later in the script.

Methods

NRV_simulable.__init__([t_sim, dt, ...])

Init method for NRV_class

NRV_simulable.extracel_status()

Check if an extracellular context is attached to the instance

NRV_simulable.get_parameters()

Generic method returning all the atributes of an NRV_class instance

NRV_simulable.intracel_status()

Check if an intracellular context is attached to the instance

NRV_simulable.load(data[, blacklist])

Generic loading method for NRV_class instance

NRV_simulable.rec_status()

Check if a recording context is attached to the instance

NRV_simulable.save([save, fname, blacklist])

Generic saving method for NRV_class instance.

NRV_simulable.set_parameters(**kawrgs)

Generic method to set any attribute of NRV_class instance

NRV_simulable.simulate(**kwargs)

Generic start of the simulate method.