.. _pynest_api:

PyNEST API
==========

The ``nest`` module contains methods and attributes to control the NEST kernel.
This interface is known as PyNEST. You can browse the various functions to use in your NEST script.

Functions related to models
---------------------------

* :doc:`nest.lib.hl_api_models`

Functions related to the creation and retrieval of nodes (neurons, devices)
----------------------------------------------------------------------------

* :doc:`nest.lib.hl_api_nodes`

Functions related to spatially distributed nodes
------------------------------------------------

* :doc:`nest.lib.hl_api_spatial`


Functions related to setting and getting parameters
---------------------------------------------------

* :doc:`nest.lib.hl_api_info`
* :doc:`nest.lib.hl_api_types`

Functions related to connections
---------------------------------

* :doc:`nest.lib.hl_api_connections`

Functions related to simulation
--------------------------------

* :doc:`nest.lib.hl_api_simulation`


Functions related to parallel computing
----------------------------------------

* :doc:`nest.lib.hl_api_parallel_computing`

Functions related to visual elements
------------------------------------

* :doc:`nest.raster_plot`
* :doc:`nest.visualization`
* :doc:`nest.voltage_trace`


Functions related to randomization
----------------------------------

* :doc:`nest.random.hl_api_random`

Functions related to mathematical expressions
---------------------------------------------

* :doc:`nest.math.hl_api_math`

* :doc:`nest.logic.hl_api_logic`

Functions related to spatial distributions
------------------------------------------

* :doc:`nest.spatial.hl_api_spatial`
* :doc:`nest.spatial_distributions.hl_api_spatial_distributions`

Functions related to server
---------------------------

* :doc:`nest.server.hl_api_server`


Kernel attributes
-----------------

* :doc:`kernel_attributes`

Additional helper functions
---------------------------

* :doc:`nest.lib.hl_api_helper`



.. toctree::
   :hidden:
   :glob:

   *