.. LMReanalysis documentation master file, created by
   sphinx-quickstart on Fri Sep 30 14:49:52 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

******************************
Last Millenium Reanalysis Docs
******************************

Welcome to the LMR project documentation!
=========================================

The Last Millennium Reanalysis (LMR) code provides a framework for ensemble
Kalman filter paleoclimate reconstructions from [Hakim2016]_.  Its modular
design facilitates rapid prototyping and experimentation for paleoclimate
research.  The code can be found on
`Github <https://www.github.com/modons/LMR>`_ and we welcome collaborators to
build and improve on the framework!

Version |version|

Documentation generated: |today|

**Documentation contributors:**

* R. Tardif, W. A. Perkins, G. J. Hakim, M. K. Brennan, J. A. Badgeley,
  L. A. Parsons, *University of Washington*
* M. B. Erb, *North Arizona University*

.. toctree::
   :maxdepth: 1
   :caption: Documentation

   install
   quick_recon
   full_recon
   configuration
   proxies
   prior
   psm

Contributing to docs
--------------------
The documentation needs more work!  If you'd like to contribute, please
consider taking a bit of time to write on a topic.


If there's some usage of the LMR framework that's not described, write about it!
The documentation is written using reStructuredText format and generated
using Sphinx.

Resources
^^^^^^^^^
* `reST overview <http://www.sphinx-doc.org/en/1.5.1/rest.html>`_
* `Sphinx tutorial <http://www.sphinx-doc.org/en/1.5.1/tutorial.html>`_



Citations
---------
.. [Hakim2016] Hakim, G. J., Emile-Geay, J., Steig, E. J., Noone, D., Anderson,
 D. M., Tardif, R., … Perkins, W. A. (2016). The Last Millennium Climate
 Reanalysis Project: Framework and First Results. Journal of Geophysical
 Research: Atmospheres. http://doi.org/10.1002/2016JD024751