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: dict[str, Array]
-
channel_states: dict[str, Array]
-
current_name: str
-
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:
-
- Return type:
None
-
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.
- Return type:
None
-
init_state(states, v, params, delta_t)[source]
Initialize states of channel.
- Parameters:
-
