jaxley.pumps.Pump#

class Pump(name=None)[source]#

Bases: object

Pump base class. All pumps inherit from this class.

A pump in Jaxley is everything that modifies the intracellular ion concentrations.

Parameters:

name (str | None)

channel_params = None#
channel_states = None#
current_name = None#
property name: str | None#

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

change_name(new_name)[source]#

Change the pump name.

Parameters:

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

Returns:

Renamed pump, such that this function is chainable.

update_states(states, v, params)[source]#

Update the states of the pump.

Parameters:
compute_current(states, v, params)[source]#

Given channel states and voltage, return the change in ion concentration.

Parameters:
  • states (Dict[str, Array]) – All states of the compartment.

  • v – Voltage of the compartment in mV.

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

Returns:

Ion concentration change in mM.

init_state(states, v, params, delta_t)[source]#

Initialize states of channel.

Parameters: