Skip to content

Commit

Permalink
A bit of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeldeistler committed Feb 3, 2024
1 parent a2f9627 commit b0a0ca0
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion jaxley/modules/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ def _step_channels(
channel_nodes: pd.DataFrame,
params: Dict[str, jnp.ndarray],
):
"""One step of integration of the channels."""
"""One step of integration of the channels and of computing their current."""
states = self._step_channels_state(
states, delta_t, channels, channel_nodes, params
)
Expand All @@ -551,6 +551,7 @@ def _step_channels_state(
channel_nodes: pd.DataFrame,
params: Dict[str, jnp.ndarray],
):
"""One integration step of the channels."""
voltages = states["voltages"]

# Update states of the channels.
Expand Down Expand Up @@ -586,6 +587,10 @@ def _channel_currents(
channel_nodes: pd.DataFrame,
params: Dict[str, jnp.ndarray],
):
"""Return the current through each channel.
This is also updates `state` because the `state` also contains the current.
"""
voltages = states["voltages"]

# Compute current through channels.
Expand Down

0 comments on commit b0a0ca0

Please sign in to comment.