Soma#

class dendrify.compartment.Soma(name, model='leakyIF', **kwargs)[source]#

Bases: Compartment

A class that automatically generates and handles all differential equations and parameters needed to describe a somatic compartment and any currents (synaptic, dendritic, noise) passing through it.

See also

Soma acts as a wrapper for Compartment with slight changes to account for certain somatic properties. For a full list of its methods and attributes, please see: Compartment.

Parameters:

  • name (str) – A unique name used to tag compartment-specific equations and parameters. It is also used to distinguish the various compartments belonging to the same NeuronModel.

  • model (str, optional) – A keyword for accessing Dendrify’s library models. Custom models can also be provided but they should be in the same formattable structure as the library models. Available options: 'leakyIF' (default), 'adaptiveIF', 'adex'.

  • kwargs (Quantity, optional) – Kwargs are used to specify important electrophysiological properties, such as the specific capacitance or resistance. For more information see: EphysProperties.

Examples

>>> # specifying equations only:
>>> somaX = Soma('nameX', 'leakyIF')
>>> # specifying equations and ephys properties:
>>> somaY = Soma('nameY', 'adaptiveIF', length=100*um, diameter=1*um,
>>>              cm=1*uF/(cm**2), gl=50*uS/(cm**2))