neuronunit.models package

Submodules

neuronunit.models.backends module

neuronunit.models.channel module

NeuronUnit model class for ion channels models

class neuronunit.models.channel.ChannelModel(channel_file_path, channel_index=0, name=None)[source]

Bases: sciunit.models.Model, neuronunit.capabilities.channel.NML2_Channel_Runnable, neuronunit.capabilities.channel.ProducesIVCurve

A model for ion channels

NML2_run(rerun=False, a=None, verbose=None, **run_params)[source]
plot_iv_curve(v, i, *plt_args, **plt_kwargs)[source]

Plots IV Curve using array-like voltage ‘v’ and array-like current ‘i’

produce_iv_curve(**run_params)[source]

Produces steady-state and peak IV curve at voltages and conditions given according to ‘run_params’

produce_iv_curve_peak(**run_params)[source]

Produces peak current IV curve at voltages and conditions given according to ‘run_params’

produce_iv_curve_ss(**run_params)[source]

Produces steady-state IV curve at voltages and conditions given according to ‘run_params’

neuronunit.models.reduced module

NeuronUnit model class for reduced neuron models

class neuronunit.models.reduced.ReducedModel(LEMS_file_path, name=None, backend=None, attrs=None)[source]

Bases: neuronunit.models.lems.LEMSModel, neuronunit.capabilities.ReceivesSquareCurrent, neuronunit.capabilities.ProducesActionPotentials

Base class for reduced models, using LEMS

get_APs(**run_params)[source]

Gets action potential waveform chunks from the model.

Must return a neo.core.AnalogSignal. Each column of the AnalogSignal should be a spike waveform.

get_membrane_potential(**run_params)[source]

Must return a neo.core.AnalogSignal.

get_spike_train(**run_params)[source]

Gets computed spike times from the model.

Arguments: None. Returns: a neo.core.SpikeTrain object.

inject_square_current(current)[source]

Injects somatic current into the model.

current : a dictionary like:
{‘amplitude’:-10.0*pq.pA,
‘delay’:100*pq.ms, ‘duration’:500*pq.ms}}

where ‘pq’ is the quantities package

This describes the current to be injected.

Module contents

Model classes for NeuronUnit