.. _command_help:

Get help on the command line interface
======================================

* The :py:func:`.helpdesk` command will launch the documentation pages on your browser.

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

.. code-block::

   # 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:

.. code-block:: python

   nest.node_models

* To get a list of available synapse models, use:

.. code-block:: python

   nest.synapse_models

* To get details on the model equations and parameters,
  please check out our :doc:`model documentation <models/index>`.
