.. GoodVibes documentation master file, created by
   sphinx-quickstart on Mon Aug 19 15:23:16 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

GoodVibes User Documentation
========================================
.. image:: ../GoodVibes.png
  :width: 800
  :alt: GoodVibes Logo

.. image:: https://travis-ci.org/bobbypaton/GoodVibes.svg?branch=master
  :target: https://travis-ci.org/bobbypaton/GoodVibes
  :alt: travis badge
.. image:: https://badge.fury.io/py/goodvibes.svg
  :target: https://badge.fury.io/py/goodvibes
  :alt: pypi badge
.. image:: https://anaconda.org/patonlab/goodvibes/badges/installer/conda.svg
  :target: https://conda.anaconda.org/patonlab
  :alt: conda badge
.. image:: https://anaconda.org/patonlab/goodvibes/badges/downloads.svg
  :target: https://anaconda.org/patonlab/goodvibes
  :alt: conda download badge
.. image:: https://readthedocs.org/projects/goodvibespy/badge/?version=stable
  :target: https://goodvibespy.readthedocs.io/en/stable/?badge=stable
  :alt: docs badge
.. image:: https://img.shields.io/badge/DOI-10.12688%2Ff1000research.22758.1-orange
  :target: https://doi.org/10.12688/f1000research.22758.1
  :alt: f1000 badge
  

.. toctree::
   :maxdepth: 2
   :caption: Getting Started:

   source/README


.. toctree::
   :maxdepth: 2
   :caption: Programmatic API:

   source/api_guide


.. toctree::
   :maxdepth: 2
   :caption: Cookbook:

   source/cookbook


.. toctree::
   :maxdepth: 2
   :caption: Migration:

   source/migration_v5


.. toctree::
   :maxdepth: 3
   :caption: Module reference:

   source/goodvibes
   

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

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