hnn_core.calcium_model#

hnn_core.calcium_model(params=None, add_drives_from_params=False, legacy_mode=False, mesh_shape=(10, 10))[source]#

Instantiate the Jones 2009 model with improved calcium dynamics in L5 pyramidal neurons. For more details on changes to calcium dynamics see Kohl et al. Brain Topragr 2022 [1]

Parameters:

paramsstr | Path | dict | None, default=None: Custom Network parameters to use, if any. If string or Path, it is assumed to be a path to a legacy “flat” JSON file containing the parameters in the style of hnn_core/param/default.json (NOT a modern “hierarchical” JSON file like hnn_core/param/neymotin2020_base.json). If dict, it is assumed to be a dictionary of parameters in the “flat” JSON style. If None (the default), the default parameters are used from hnn_core/param/default.json. Note that if you have drive parameters included, but you ALSO set the deprecated add_drives_from_params to True, the drives will be added twice if the drive names are the same.
add_drives_from_paramsbool, default=False: If True, add drives as defined in the params-dict. NB this is mainly for backward-compatibility with HNN GUI, and will be deprecated in a future release. Default: False
legacy_modebool, default=False: Set to False by default. Enables matching HNN GUI output when drives are added suitably. Will be deprecated in a future release.
mesh_shapetuple of int (default: (10, 10)): Defines the (n_x, n_y) shape of the grid of pyramidal cells.

Returns:

netInstance of Network object: Network object used to store the Jones 2009 model with an improved calcium channel distribution.