.. _pynest_apis:

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

Here is a list of functions for the PyNEST interface.


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

.. automodule:: nest.lib.hl_api_models
    :members:

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

.. automodule:: nest.lib.hl_api_nodes
    :members:

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

.. automodule:: nest.lib.hl_api_info
    :members:

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

.. automodule:: nest.lib.hl_api_connections
    :members:

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

.. automodule:: nest.lib.hl_api_simulation
    :members:

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

.. automodule:: nest.lib.hl_api_parallel_computing
    :members:

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

.. note::

 This used to be a separate topology module. Now, it is integrated into NEST 3.0.

.. automodule:: nest.lib.hl_api_spatial
    :members:

Functions related to NEST types
-------------------------------

.. automodule:: nest.lib.hl_api_types
    :members:

Functions related to helper info
---------------------------------

.. automodule:: nest.lib.hl_api_helper
    :members:

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

.. automodule:: nest.random.hl_api_random
    :members:

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

.. automodule:: nest.spatial.hl_api_spatial
    :members:

.. automodule:: nest.spatial_distributions.hl_api_spatial_distributions
    :members:

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

.. automodule:: nest.math.hl_api_math
    :members:

.. automodule:: nest.logic.hl_api_logic
    :members: