.. _topics-index:

.. toctree::
   :caption: Getting started
   :hidden:
   :maxdepth: 1

   Overview <self>
   getting_started/install
   Quickstart <examples/plot_quickstart>

.. toctree::
   :caption: Core concepts
   :hidden:

   concepts/implants
   concepts/stimulation
   concepts/models
   concepts/vision
   concepts/coordinates
   concepts/units
   concepts/datasets

.. toctree::
   :caption: Scientific examples
   :hidden:

   examples/index

.. toctree::
   :caption: Reference
   :hidden:

   reference/api
   reference/faq
   reference/release_notes
   reference/references
   reference/news

.. toctree::
   :caption: Developer Guide
   :hidden:

   developers/contributing
   developers/style_guide
   developers/benchmarks
   developers/releases

.. include:: ../README.rst
   :end-before: .. badges-end

|

=====================================
pulse2percept |version| documentation
=====================================

.. include:: ../README.rst
   :start-after: .. intro-begin
   :end-before: .. quickstart-end

Compatibility
=============

.. include:: ../README.rst
   :start-after: .. compat-begin
   :end-before: .. compat-end

Where to go from here
=====================

*  Run the :doc:`Quickstart <examples/plot_quickstart>`.
*  Read the core concepts in order: :doc:`implants <concepts/implants>`,
   :doc:`stimulation <concepts/stimulation>`,
   :doc:`models and percepts <concepts/models>`,
   :doc:`visual input <concepts/vision>`,
   :doc:`coordinates <concepts/coordinates>`, :doc:`units <concepts/units>`, and
   :doc:`datasets <concepts/datasets>`.
*  Work through the :doc:`Example Gallery <examples/index>`, starting with the
   key examples.
*  Check the :doc:`FAQ <reference/faq>` for common questions.
*  Request features or report bugs on the `Issue Tracker`_.

.. _Issue Tracker: https://github.com/pulse2percept/pulse2percept/issues
