.. pyrates documentation master file, created by
   sphinx-quickstart on Wed Oct  3 12:55:59 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

RectiPy Documentation
=====================

Documentation of `RectiPy <https://github.com/pyrates-neuroscience/RectiPy>`_, an open-source Python toolbox for recurrent neural network simulations and optimization.

Content
-------

:doc:`Overview`
   `RectiPy` features, installation instructions, and other general information.

:doc:`Use Examples`
   Galleries containing fully documented use examples that can be downloaded as `Python` scripts or `jupyter notebook` files.

:doc:`API`
   Detailed API of all classes and functions available to the user.

.. Hidden TOCs

.. toctree::
   :caption: Overview
   :maxdepth: 2
   :hidden:

   basic_info
   installation
   simple_example
   changelog

.. toctree::
    :maxdepth: 4
    :numbered:
    :caption: Use Examples
    :hidden:

    models
    interfaces

.. toctree::
    :maxdepth: 5
    :numbered:
    :caption: API
    :hidden:

    rectipy
    neuron_model_templates
    tests

Reference
---------

If you use `RectiPY`, please cite the most recent release:

.. image:: https://zenodo.org/badge/523464500.svg
   :target: https://zenodo.org/badge/latestdoi/523464500

Contact
-------

If you have questions, problems or suggestions regarding RectiPy, please contact `Richard Gast <https://www.richardgast.me>`_.

Contribute
----------

RectiPy is an open-source project that everyone is welcome to contribute to. Check out our `GitHub repository <https://github.com/pyrates-neuroscience/RectiPy>`_
for all the source code, open issues etc. and send us a pull request, if you would like to contribute something to our software.