jaxley.channels.Rate

class Rate(name=None)

Bases: Channel

Rate-based, unit-less, neuron model.

The following parameters are registered in channel_params:

Name	Default	Description	Unit
tau	1	Time constant of the neuron (unitless).	1

The channel has no internal states.

Parameters:

name (str | None)

channel_params = None

channel_states = None

current_name = None

update_states(states, params, voltage, delta_t)

Voltages get pulled towards zero.

Parameters:

• states (dict[str, Array])

• params (dict[str, Array])

• voltage (Array)

• delta_t (float)

compute_current(states, params, voltage, delta_t)

Given channel states and voltage, return the current through the channel.

Parameters:

• states (dict[str, Array]) – All states of the compartment.

• params (dict[str, Array]) – Parameters of the channel (conductances in S/cm2).

• voltage (Array) – Voltage of the compartment in mV.

• delta_t (float) – The time step in ms.

Returns:

Current in uA/cm2.

init_state(states, params, voltage, delta_t)

Initialize states of channel.

Parameters:

• states (dict[str, Array]) – All states of the compartment.

• params (dict[str, Array]) – Parameters of the channel (conductances in S/cm2).

• voltage (Array) – Voltage of the compartment in mV.

• delta_t (float) – The time step in ms.

Returns:

A initial state that is written into module.nodes when the user runs module.init_states().

change_name(new_name)

Change the channel name.

Parameters:

new_name (str) – The new name of the channel.

Returns:

Renamed channel, such that this function is chainable.

init_params(states, params, voltage, delta_t)

Initialize the maximal conductances given the temperature.

Parameters:

• states (dict[str, Array]) – All states of the compartment.

• params (dict[str, Array]) – Parameters of the channel (conductances in S/cm2).

• voltage (Array) – Voltage of the compartment in mV.

• delta_t (float) – The time step in ms.

Returns:

Initial parameters that are written into module.nodes when the user runs module.init_params().

Return type:

dict[str, Array]

property name: str | None

The name of the channel (by default, this is the class name).