Info module

Functions to provide additional information.

Functions to get information on NEST.

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

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

nest.lib.hl_api_info.help(obj=None, return_text=False)

Display the help page for the given object in a pager.

If return_text is omitted or explicitly given as False, this command opens the help text for object in the default pager using the pydoc module.

If return_text is True, the help text is returned as a string in reStructuredText format instead of displaying it.

Parameters:

• obj (object, optional) – Object to display help for

• return_text (bool, optional) – Option for returning the help text

Returns:

The help text of the object if return_text is True.

Return type:

None or str

nest.lib.hl_api_info.message(message, severity=nest.nestkernel_api.VerbosityLevel.INFO, *, function=None, filename=None, lineno=None)

Issue message via NEST logging mechanism.

Calling function, the name of the source code file and the pertaining line number are added automatically if not explicitly given. These values are only displayed by the NEST logging mechanism if verbosity is DEBUG or ALL.

When setting the severity of the issue, pass severity=nest.VerbosityLevel.WARNING and similar. Default is INFO.