Info module¶

Functions to provide additional information.

Functions to get information on NEST.

nest.lib.hl_api_info.GetStatus(nodes, keys=None, output='')¶

Return the parameter dictionaries of nodes or connections.

If keys is given, a list of values is returned instead. keys may also be a list, in which case the returned list contains lists of values.

Parameters:

nodes (NodeCollection or SynapseCollection) – Either a NodeCollection representing nodes, or a SynapseCollection of connection handles as returned by GetConnections().
keys (str or list, optional) – string or a list of strings naming model properties. GetStatus then returns a single value or a list of values belonging to the keys given.
output (str, optional) – Whether the returned data should be in a selected format (output='json').

Returns:

list of dicts – All parameters in a dict for each node or connection.
list of values – If keys is a string, the value of the corresponding parameter for each node or connection is returned.
list of lists of values – If keys is a list of strings, a list of values of the corresponding parameters for each node or connection is returned.
str – If output is json, the above formats are converted to JSON format before they are returned.

Raises:

TypeError – If nodes or keys are on the wrong form.

Examples

For nodes:

>>>    nest.GetStatus(nodes)
       ({'archiver_length': 0,
         'beta_Ca': 0.001,
         ...
         'global_id': 1,
         ...
         'vp': 0},
        ...
        {'archiver_length': 0,
         'beta_Ca': 0.001,
         ...
         'global_id': 3,
         ...
         'vp': 0})

>>>    nest.GetStatus(nodes, 'V_m')
       (-70.0, -70.0, -70.0)

>>>    nest.GetStatus(nodes, ['V_m', 'C_m'])
       ((-70.0, 250.0), (-70.0, 250.0), (-70.0, 250.0))

>>>    nest.GetStatus(nodes, ['V_m', 'C_m'], output='json')
       '[[-70.0, 250.0], [-70.0, 250.0], [-70.0, 250.0]]'

For connections:

>>>    nest.GetStatus(conns)
       ({'delay': 1.0,
         ...
         'source': 1,
         ...
         'weight': 1.0},
        ...
        {'delay': 1.0,
         ...
         'source': 3,
         ...
         'weight': 1.0})

>>>    nest.GetStatus(conns, 'weight')
       (1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0)

>>>    nest.GetStatus(conns, ['source', 'delay'])
       ((1, 1.0),
        ...
        (3, 1.0))

>>>    nest.GetStatus(conns, ['source', 'delay'], output='json')
       '[[1, 1.0], [1, 1.0], [1, 1.0], [2, 1.0], [2, 1.0], [2, 1.0],
       [3, 1.0], [3, 1.0], [3, 1.0]]'

nest.lib.hl_api_info.SetStatus(nodes, params, val=None)¶

Set parameters of nodes or connections.

Parameters of nodes or connections, given in nodes, is set as specified by params. If val is given, params has to be a string with the name of an attribute, which is set to val on the nodes/connections. val can be a single value or a list of the same size as nodes.

Parameters:

nodes (NodeCollection or SynapseCollection) – Either a NodeCollection representing nodes, or a SynapseCollection of connection handles as returned by GetConnections().
params (str or dict or list) – Dictionary of parameters (either lists or single values) or list of dictionaries of parameters of same length as nodes. If val is given, this has to be a string giving the name of a model property.
val (int, list, optional) – If given, params has to be the name of a model property.

Raises:

TypeError – If nodes is not a NodeCollection of nodes, a SynapseCollection of synapses, or if the number of parameters don’t match the number of nodes or synapses.