Variable

Variable(
    self,
    equation,
    init=None,
    min=None,
    max=None,
    method=None,
    locality='local',
    type='float',
)

Dataclass to represent a variable in a Neuron or Synapse definition.

neuron = ann.Neuron(
    equations = [
        ann.Variable('C * dv/dt = - gL * (v - E_L) +  gL * delta_T * exp((v-v_T)/delta_T) + I - w', init=-70.0),

        ann.Variable('tau_w * dw/dt = a * (v - E_L) - w', min=0.0),
    ]
)

Variables are local by default. Set locality to global or semiglobal otherwise.

Parameters

Name	Type	Description	Default
equation	str	string representing the equation.	required
init	float | int | bool | RandomDistribution	initial value of the variable. It can be defined as a RandomDistribution, which will be sampled with the correct shape when the population/projection is created, or a float/int/bool, depending on type.	None
min	float	minimum value that the variable can take.	None
max	float	maximum value that the variable can take.	None
method	str	numerical method to be used when the equation is an ODE. Must be in [‘explicit’, ‘implicit’, ‘semiimplicit’, ‘exponential’,‘midpoint’, ‘rk4’, ‘event-driven’]	None
locality	str	Locality of the parameter. Must be in [‘global’, ‘semiglobal’, ‘local’].	'local'
type	str	Data type of the parameter. Must be in [float, int, bool] (or [‘float’, ‘int’, ‘bool’]).	'float'