.. pycopancore documentation master file, created by
   sphinx-quickstart on Wed Jun  1 10:59:39 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


pycopancore: a Python package implementing the copan\:CORE World-Earth modeling framework and base model
========================================================================================================

The source code is available at `https://github.com/pik-copan/pycopancore
<https://github.com/pik-copan/pycopancore>`_.

Contents:

.. The following structure roughly follows http://docs.python-guide.org/en/latest/writing/documentation/,
   but with license added and "developer documentation" renamed to "framework documentation" due to the different roles of people involved.

.. TODO: move introduction to inside this page so that it is more immediately available for reading?

.. toctree::
   :maxdepth: 3
   :titlesonly:

   introduction
   license
   api_reference
   tutorials/all-in-one/index
   framework_documentation/index

Indices and tables
------------------

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