braincell.channel module#

Channel Templates#

The catalogue below is built from a handful of templates. A new channel declares its gates or transitions and its rate functions, and inherits the current law from one of these.

Gate

Metadata for one HH gate.

Transition

One directed or reversible transition used by Markov channels.

HH

HH gate dynamics with per-gate auto-detected form.

OhmicHH

HH gating driven by an ohmic current, \(g \cdot \prod g_i^{p_i} \cdot (E - V)\).

GhkHH

HH gating driven by a constant-field (GHK) flux.

Markov

Probability-state channel kinetics described by transition pairs.

OhmicMarkov

Markov kinetics driven by an ohmic current.

ghk_flux

Compute the Goldman-Hodgkin-Katz constant-field flux, per permeability.

q10_factor

Return the Q10 rate-scaling factor for one temperature offset.

freeze_gradient

Return value with gradients through it stopped, keeping its unit.

Calcium Channels#

CaN_IS2008

Inoue & Strowbridge 2008 Ca-activated nonselective cation current.

CaL_IS2008

Inoue & Strowbridge 2008 L-type calcium current.

CaT_HM1992

Huguenard & McCormick 1992 low-threshold T-type calcium current.

CaT_HP1992

Huguenard & Prince 1992 T-type calcium current for reticular nucleus.

CaHT_HM1992

Depolarized-shift variant of the Huguenard & McCormick 1992 T current.

CaHT_Re1993

Reuveni 1993 high-threshold calcium current.

CaHVA_MA2020_GoC

Golgi cell high-voltage-activated calcium current.

CaHVA_MA2020_GrC

Granule cell high-voltage-activated calcium current.

CaHVA_SU2015_DCN

HVA calcium current of the DCN model (Sudhakar 2015).

CaLVA_SU2015_DCN

GHK-drive LVA calcium current of the DCN model (Sudhakar 2015).

CaL_SU2015_DCN

Ohmic-drive LVA calcium current of the DCN model (Sudhakar 2015).

Ca_ZH2019_IO

Somatic calcium current of the inferior-olive model (Zhang 2019).

Ca_ZH2019_IO_Frozen

Ca_ZH2019_IO with freeze_m_inf pinned to True.

Cav1p2_MA2020_GoC

Golgi cell Cav1.2 L-type calcium current with Ca inactivation.

Cav1p2_MA2025_BC

Cav1.2 L-type calcium current, basket-cell parameterisation.

Cav1p3_MA2020_GoC

Golgi cell Cav1.3 L-type calcium current with Ca inactivation.

Cav1p3_MA2025_BC

Cav1.3 L-type calcium current, basket-cell parameterisation.

Cav2p1_MA2024_PC

Purkinje cell Cav2.1 P-type calcium current, GHK drive.

Cav2p1_MA2024_PC_Frozen

Purkinje cell Cav2.1 with the GHK drive frozen for autodiff.

Cav2p1_MA2025_BC

Basket cell Cav2.1 P-type calcium current with GHK drive.

Cav2p1_MA2025_BC_Frozen

Basket cell Cav2.1 with the GHK drive frozen for autodiff.

Cav2p1_RI2021_SC

Stellate cell Cav2.1 P-type calcium current with GHK drive.

Cav2p1_RI2021_SC_Frozen

Stellate cell Cav2.1 with the GHK drive frozen for autodiff.

Cav2p3_MA2020_GoC

Golgi cell Cav2.3 R-type, medium-threshold calcium current.

Cav3p1_MA2020_GoC

Golgi cell Cav3.1 low-threshold calcium current with GHK drive.

Cav3p1_MA2020_GoC_Frozen

Golgi cell Cav3.1 with the GHK drive frozen for autodiff.

Cav3p1_MA2024_PC

Purkinje cell Cav3.1 low-threshold calcium current, GHK drive.

Cav3p1_MA2024_PC_Frozen

Purkinje cell Cav3.1 with the GHK drive frozen for autodiff.

Cav3p1Test_PC24

Cav3.1 test variant with the GHK drive replaced by a constant.

Cav3p2_MA2024_PC

Purkinje cell Cav3.2 low-threshold T-type calcium current.

Cav3p2_MA2025_BC

Basket cell Cav3.2 low-threshold T-type calcium current.

Cav3p2_RI2021_SC

Stellate cell Cav3.2 low-threshold T-type calcium current.

Cav3p3_MA2024_PC

Purkinje cell Cav3.3 low-threshold calcium current, GHK drive.

Cav3p3_MA2024_PC_Frozen

Purkinje cell Cav3.3 with the GHK drive frozen for autodiff.

Cav3p3_RI2021_SC

Stellate cell Cav3.3 low-threshold calcium current, GHK drive.

Hyperpolarization-Activated Channels#

HCN_HM1992

Hyperpolarization-activated current of Huguenard & McCormick (1992).

HCN_SU2015_DCN

H-current imported for the deep cerebellar nucleus (DCN) model.

HCN_ZH2019_IO

Inferior olive somatic h-current, imported from HCN_ZH19_IO.mod.

HCN1_MA2020_GoC

HCN1 fast/slow h-current imported for the Golgi cell model.

HCN1_MA2024_PC

HCN1 h-current imported for the human Purkinje cell model.

HCN1_MA2025_BC

HCN1 h-current imported for the cerebellar basket cell model.

HCN1_RI2021_SC

HCN1 h-current imported for the cerebellar stellate cell model.

HCN2_MA2020_GoC

HCN2 fast/slow h-current imported for the Golgi cell model.

Leakage Channels#

LeakageChannel

Base class for leakage channel dynamics.

IL

The leakage channel current.

Potassium Channels#

K_HH1952

Hodgkin-Huxley 1952 delayed-rectifier potassium current.

K_TM1991

Traub and Miles 1991 delayed-rectifier potassium current.

K_Leak

Potassium leak current.

K_Kv_test

Scratch Kv fixture built on the generic vtrap rate form.

KDR_Ba2002

Bazhenov 2002 delayed-rectifier potassium current.

Kdr_ZH2019_IO

Delayed rectifier of the inferior-olive model (Zhang 2019).

KA1_HM1992

Huguenard & McCormick 1992 A-type potassium current (IA1).

KA2_HM1992

Huguenard & McCormick 1992 A-type potassium current (IA2).

KK2A_HM1992

Huguenard & McCormick 1992 slow potassium current (IK2a).

KK2B_HM1992

Huguenard & McCormick 1992 slow potassium current (IK2b).

KNI_Ya1989

Yamada 1989 slow non-inactivating potassium current.

KM_MA2020_GoC

M-type potassium current of the Golgi cell model.

KM_MA2020_GrC

M-type potassium current of the granule cell model.

KM_RI2021_SC

M-type potassium current of the stellate cell model.

Kir2p3_MA2020_GrC

Kir2.3 inward-rectifier current of the granule cell model.

Kir2p3_MA2024_PC

Kir2.3 inward-rectifier current of the Purkinje cell model.

Kir2p3_MA2025_BC

Kir2.3 inward-rectifier current of the basket cell model.

Kir2p3_RI2021_SC

Kir2.3 inward-rectifier current of the stellate cell model.

Kv1p1_MA2020_GoC

Kv1.1 low-threshold potassium current of the Golgi cell model.

Kv1p1_MA2020_GrC

Kv1.1 low-threshold potassium current of the granule model.

Kv1p1_MA2024_PC

Kv1.1 low-threshold potassium current of the Purkinje model.

Kv1p1_MA2025_BC

Kv1.1 low-threshold potassium current of the basket cell model.

Kv1p1_RI2021_SC

Kv1.1 low-threshold potassium current of the stellate model.

Kv1p5_MA2020_GrC

Granule-cell Kv1.5 channel with two current owners.

Kv1p5_MA2024_PC

Kv1.5 ultrarapid delayed-rectifier current (IKur), K path only.

Kv2p2_0010_MA2020_GrC

Kv2.2 delayed-rectifier current of the granule cell model.

Kv3p3_MA2024_PC

Kv3.3 high-threshold potassium current of the Purkinje model.

Kv3p4_MA2020_GoC

Fast TEA-sensitive potassium current of the Golgi cell model.

Kv3p4_MA2020_GrC

Fast TEA-sensitive potassium current of the granule cell model.

Kv3p4_MA2024_PC

Fast TEA-sensitive potassium current of the Purkinje cell model.

Kv3p4_MA2025_BC

Fast TEA-sensitive potassium current of the basket cell model.

Kv3p4_RI2021_SC

Fast TEA-sensitive potassium current of the stellate cell model.

Kv4p3_MA2020_GoC

A-type transient potassium current of the Golgi cell model.

Kv4p3_MA2020_GrC

A-type transient potassium current of the granule cell model.

Kv4p3_MA2024_PC

A-type transient potassium current of the Purkinje cell model.

Kv4p3_MA2025_BC

A-type transient potassium current of the basket cell model.

Kv4p3_RI2021_SC

A-type transient potassium current of the stellate cell model.

fKdr_SU2015_DCN

Fast delayed rectifier of the DCN model (Sudhakar 2015).

sKdr_SU2015_DCN

Slow delayed rectifier of the DCN model (Sudhakar 2015).

Potassium-Calcium Channels#

AHP_De1994

Calcium-activated after-hyperpolarization current.

SK_SU2015_DCN

Small-conductance calcium-activated potassium current, DCN.

Kca1p1_MA2020_GoC

Kca1.1 (BK/mslo) Ca- and voltage-activated K current, Golgi cell.

Kca1p1_MA2020_GrC

Kca1.1 Ca- and voltage-activated K current, granule-cell variant.

Kca1p1_MA2024_PC

Kca1.1 Ca- and voltage-activated K current, Purkinje-cell variant.

Kca1p1_MA2025_BC

Kca1.1 Ca- and voltage-activated K current, basket-cell variant.

Kca1p1_RI2021_SC

Kca1.1 Ca- and voltage-activated K current, stellate-cell variant.

Kca2p2_MA2020_GoC

Kca2.2 (SK2) calcium-activated K current, Golgi cell.

Kca2p2_MA2020_GrC

Kca2.2 calcium-activated K current, granule-cell parameterisation.

Kca2p2_MA2024_PC

Kca2.2 calcium-activated K current, Purkinje-cell parameterisation.

Kca2p2_MA2025_BC

Kca2.2 calcium-activated K current, basket-cell parameterisation.

Kca2p2_RI2021_SC

Kca2.2 calcium-activated K current, stellate-cell parameterisation.

Kca3p1_MA2020_GoC

Kca3.1 (IK) calcium-activated K current, Golgi cell.

Kca3p1_MA2024_PC

Kca3.1 calcium-activated K current, Purkinje-cell parameterisation.

Kca3p1_MA2025_BC

Kca3.1 calcium-activated K current, basket-cell parameterisation.

Sodium Channels#

Na_HH1952

Hodgkin-Huxley 1952 sodium current with \(p^3 q\) HH gating.

Na_TM1991

Traub and Miles 1991 sodium current with \(p^3 q\) HH gating.

Na_Ba2002

Bazhenov 2002 sodium current with \(p^3 q\) HH gating.

Na_ZH2019_IO

Inferior olive somatic sodium current, Schweighofer kinetics.

NaF_SU2015_DCN

Fast sodium current of the deep cerebellar nuclei model.

NaP_SU2015_DCN

Persistent sodium current of the deep cerebellar nuclei model.

NaFHF_MA2020_GrC

Resurgent Nav sodium current with slow block, granule-cell model.

Nav_MA2020_GrC

Resurgent Nav sodium current, granule-cell parameterisation.

Nav1p1_MA2025_BC

Non-resurgent Nav1.1 sodium current, basket-cell parameterisation.

Nav1p1_RI2021_SC

Non-resurgent Nav1.1 sodium current, stellate-cell parameterisation.

Nav1p6_MA2020_GoC

Resurgent Nav1.6 sodium current, Golgi-cell parameterisation.

Nav1p6_MA2024_PC

Resurgent Nav1.6 sodium current, Purkinje-cell parameterisation.

Nav1p6_MA2025_BC

Resurgent Nav1.6 sodium current, basket-cell parameterisation.

Nav1p6_RI2021_SC

Resurgent Nav1.6 sodium current, stellate-cell parameterisation.