3.1.1.1. SomaProducesMembranePotential

class SomaProducesMembranePotential[source]

Bases: sciunit.capabilities.Capability

Enables recording membrane potential from soma

Methods Summary

get_soma_membrane_potential(tstop)

Run simulation for time ‘tstop’, specified in ms, while recording the somatic membrane potential.

get_soma_membrane_potential_eFEL_format(…)

Calls get_soma_membrane_potential() and reformats its output structure into format accepted by eFEL library.

Methods Documentation

get_soma_membrane_potential(tstop)[source]
Run simulation for time ‘tstop’, specified in ms, while recording the somatic membrane potential.

Must return a list of the form:

[ list1, list2 ] where,
list1 = time series (in ms)
list2 = membrane potential series (in mV)

Note

This methods needs to be implemented by the model to satisfy this capability.

Parameters

tstop (float) –

get_soma_membrane_potential_eFEL_format(tstop, start, stop)[source]

Calls get_soma_membrane_potential() and reformats its output structure into format accepted by eFEL library.

Example of output format:

efel_trace = {'T' : [time series in ms],
              'V' : [somatic potential series in mv],
              'stim_start' : [stimulus start time in ms],
              'stim_end'   : [stimulus end time in ms]   }
Parameters
  • tstop (float) –

  • start (float) –

  • stop (float) –

Return type

typing.Dict[str, typing.List[float]]