.. ngc-learn documentation master file, created by
   sphinx-quickstart on Wed Apr 20 02:52:17 2022.
   Note - This file needs to at least contain a root `toctree` directive.

Welcome to ngc-learn's documentation!
=====================================

**ngc-learn** is a Python library for building, simulating, and analyzing biomimetic and NeuroAI computational models, arbitrary predictive processing/coding models, spiking neural networks, and general dynamical systems. This toolkit is built on top of `JAX <https://github.com/google/jax>`_ and is distributed under the 3-Clause BSD license.

.. toctree::
   :maxdepth: 1
   :caption: Introduction:

   overview
   installation

.. toctree::
  :maxdepth: 1
  :caption: Tutorials

  tutorials/intro
  tutorials/theory
  tutorials/configuration/index
  tutorials/index
  tutorials/neurocog/index

.. toctree::
  :maxdepth: 1
  :caption: Model Museum

  museum/model_museum
  museum/index


.. toctree::
  :maxdepth: 1
  :caption: Modeling API

  modeling/components
  modeling/neurons
  modeling/synapses
  modeling/input_encoders
  modeling/other_ops

.. toctree::
   :maxdepth: 6
   :caption: Source API

   source/modules

.. toctree::
  :maxdepth: 1
  :caption: NGC-Learn Papers & Media

  ngclearn_papers
  ngclearn_talks

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`