braincell.ion module

Calcium Ions & Dynamics

Calcium	Base class for modeling Calcium ion.
CalciumFixed	Fixed Calcium dynamics.
CalciumDetailed	Dynamical Calcium model proposed.
CalciumFirstOrder	The first-order calcium concentration model.
CalciumInitNernst	Fixed Ci/Co calcium model with E initialized from Nernst.
CdpCAM_MA2024_PC	Template-based import of CdpCAM_MA24_PC.mod.
CdpCR_MA2020_GrC	Template-based import of CdpCR_MA20_GrC.mod.
CdpHVA_SU2015_DCN	Template-based import of CdpHVA_SU15_DCN.mod.
CdpLVA_SU2015_DCN	Template-based import of CdpLVA_SU15_DCN.mod.
CdpStC_MA2020_GoC	Template-based import of CdpStC_MA20_GoC.mod.
CdpStC_CAMOnly_MA2020_GoC	Template-based import of CdpStC_CAMOnly_MA20_GoC.mod.
CdpStC_NoCAM_MA2020_GoC	Template-based import of CdpStC_NoCAM_MA20_GoC.mod.
CdpStC_MA2025_BC	Thin variant for CdpStC_MA25_BC.mod.
CdpStC_RI2021_SC	Thin variant for CdpStC_RI21_SC.mod.
ToyCaBindingKinetic_SU2015_DCN	Minimal reversible calcium-binding toy for KineticIon validation.
ToyCaBindingSourceKinetic_SU2015_DCN	Minimal reversible calcium-binding toy with a constant Ci source.
ToyCaBindingIcaSourceKinetic_SU2015_DCN	Minimal reversible calcium-binding toy with current-driven Ci source.
ToyCaPumpFactorKinetic_SU2015_DCN	Minimal factor-crossing toy with cytosolic and pump-area compartments.
ToyDiamFactorKinetic_SU2015_DCN	Minimal geometry-factor toy with runtime-derived cytosolic strip factors.

Potassium Ions

Potassium	Base class for modeling Potassium ion.
PotassiumFixed	Fixed Sodium dynamics.
PotassiumInitNernst	Fixed Ci/Co potassium model with E initialized from Nernst.

Sodium Ions

Sodium	Base class for modeling Sodium ion.
SodiumFixed	Fixed Sodium dynamics.
SodiumInitNernst	Fixed Ci/Co sodium model with E initialized from Nernst.

Helpers

braincell.ion.build_placeholder_ions(size=(1,))

Return default Na/K/Ca fixed-ion containers for scaffolding.

Used by test doubles and by HHTypedNeuron construction before the real runtime ion containers are instantiated.

Parameters:

size (tuple of int, optional) – Varshape of the ion containers. Defaults to (1,).

Return type:

dict[str, object]