Getting help

Have a specific question or problem with NEST?

Check out the troubleshooting section for common issues.

If your question is not on there, you are welcome to subscribe to our Mailing List and ask.

Getting help on the command line interface

  • The helpdesk() command will launch the documentation pages on your browser.

  • To access the High-level Python API reference material you can use the commands:

    # list all functions and attributes
    dir(nest)
    
    # Get docstring for function in Python ...
    help('nest.FunctionName')
    
    # ... or in IPython
    nest.FunctionName?
    

Model information

  • To get a list of available neuron models, use:

    nest.node_models
    
  • To get a list of available synapse models, use:

    nest.synapse_models
    
  • To get details on model equations and parameters, use:

    nest.help('model_name')