.. PAVICS documentation master file, created by
   sphinx-quickstart on Mon Oct  3 13:56:31 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


PAVICS is a research platform dedicated to climate analysis and visualization. It bundles
data search, analytics and visualization services. PAVICS is developped by Ouranos, CRIM and the `birdhouse`_ community and been funded by the `CANARIE`_ research software program.

Documentation structure
-----------------------
We plan to build extensive documentation for PAVICS. We're just getting started, but please provide your comments on our `issue tracker`_.

* :doc:`Notebooks </notebooks/index>` and :doc:`tutorials </tutorials/index>` provides step by step instruction on how to use PAVICS. Start here to get a feeling of what can be done.

* :doc:`Developer Documentation </dev/index>` explains how to install and configure the various components and run system tests.

* :doc:`System Architecture <arch/index>` describes the individual components of the system and how they work together.

* :doc:`Processes </processes/index>` documents all available processes on the PAVICS platform.

* :doc:`Graphical User Interface </gui/index>` walks you through the components of the web browser frontend.


.. _issue tracker: https://github.com/Ouranosinc/pavics-sdi/issues
.. _birdhouse: http://bird-house.github.io/
.. _CANARIE: http://www.canarie.ca/


Contents
--------

.. toctree::
   :maxdepth: 2

   tutorials/index
   notebooks/index
   processes/index
   workflows/index
   gui/index
   dev/index
   arch/index
   provenance/index
   support
   releasenotes
   license
   todo




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

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